Skip to main content

Connect an Azure AD Directory

Admins can leverage Azure Active Directory (AD) to provision users and assign roles in Tonkean using the Tonkean SCIM API. To connect and configure an Azure AD directory for user provisioning, follow the process below.

You must already have an existing Azure AD tenant to follow this process. If you don't already have an Azure AD tenant, visit Azure to create one.

Prerequisites

To complete all parts of this walkthrough, you must be assigned the following roles:

  • Application Administrator

  • Attribute Assignment Administrator

  • Attribute Definition Administrator

  • Attribute Definition Reader

  • Global Administrator

Create an Identity Provider

Before configuring your directory in Azure, you must create an identity provider in Tonkean.

  1. Select your profile icon in the upper right, then select Board Settings. The Board Settings screen displays.

    board_settings_select.png
  2. In the sidenav, select Identity Provider. The Identity Provider screen displays.

    identity_provider_select.png
  3. Select Create New Provider. The Create New Provider window displays.

    create_new_provider_select.png
  4. Select the Provider Type dropdoown and choose Custom, then enter a Display Name for the identity provider. When finished, select Generate Token. The Access Token displays.

    create_new_provider_fields.png
  5. Select Copy to copy the access token. Paste the token in a separate file and close the Create New Provider window.

    This is the last time you'll be able to view the decrypted token, so make sure you save it somewhere safe for later reference.

    create_new_provider_token.png

    Leave Tonkean open in this tab. You will return to it later in the process to retrieve the SCIM API URL and confirm the addition of users using Azure.

Create an Enterprise Application in Azure AD

After creating a new identity provider in Tonkean, you can create an application in Azure AD.

  1. Open a new tab in your browser and sign in to your Azure tenant.

  2. In Azure services, select Azure Active Directory. The tenant Overview screen displays.

    azure_azure_ad_select.png
  3. In the sidenav, select Enterprise applications. The Enterprise applications screen displays.

    azure_ent_apps_select.png
  4. Select New application. The Browse Azure AD Gallery screen displays.

    ent_apps_new_app.png
  5. Select Create your own application. The Create your own application panel displays.

    ent_apps_create_your_own.png
  6. Enter a name for your application and ensure the third option, Integrate any other application you don't find in the gallery, is selected. Then, select Create.

    create_your_own_name.png

    The Overview screen for your newly-created enterprise application displays:

    ent_app_newly_created.png

Set Application Provisioning

  1. In the sidenav, select Provisioning. The {Enterprise app} | Provisioning screen displays.

    provisioning_select.png
  2. Select Get started. The Provisioning screen displays.

    provisioning_get_started.png
  3. Select the Provisioning Mode dropdown and select Automatic. The Admin Credentials fields display.

    provisioning_mode_automatic.png
  4. Enter the SCIM API URL into the Tenant URL field: https://api.tonkean.com/scim/v2

    This value is the same for all users, but you can also retrieve it by returning to the Identity Provider screen in Tonkean.

    provisioning_tenant_url.png
  5. Retrieve the access token you generated in Tonkean and paste it into the Secret Token field.

    provisioning_secret.png
  6. With both fields populated, select Test Connection.

    provisioning_test_creds.png

    Azure tests the credentials and, if successful, a success message displays in the upper right. If the test is unsuccessful, confirm that both the Tenant URL and Secret Token are entered correctly, with no additional spaces.

  7. After a successful test, select Save to save the admin credentials.

You have established the connection between your enterprise application and Tonkean and can now provision users in Tonkean through Azure AD.

Add and Map Extension Attributes in the Enterprise Application

With your enterprise application created and set up to allow provisioning, you can add custom attributes, referred to as extension properties in Azure, to your application. These extension properties define the user roles in Tonkean.

Add the Extension Property

  1. In a new tab, open Microsoft Graph Explorer.

  2. Select the profile icon in the upper right and sign in to Graph Explorer.

  3. Retrieve the id for your app to use in adding extension properties:

    1. Select GET in the method dropdown.

    2. Enter the following endpoint URL: https://graph.microsoft.com/v1.0/applications

      graph_get_app_query.png

      You can leave the Request body empty.

    3. Select Run query. The list of all enterprise applications you have permissions for in your Azure tenant is returned.

      If you don't have permission to use Graph Explorer, you may need to add the relevant permissions to your app. See the Microsoft Graph documentation for configuring Azure AD Graph permissions.

    4. In the response, use your browser Find tool ("Ctrl + f" on Windows or "cmd + f" on Mac) and search for your application by name.

    5. Locate the application object in the response and copy the value of id. Paste this value in a separate location. You can always query all applications to retrieve the value, if needed.

      This process requires the id value, not the appId value.

      graph_find_id.png
  4. Add a new extension property, "User":

    1. Select POST in the method dropdown.

    2. Enter the following endpoint URL: https://graph.microsoft.com/v1.0/applications/{id}/extensionProperties

    3. In the Request body, enter the following body:

      {
          "name": "tonkeanRoles",
          "dataType": "String",
          "targetObjects": [
              "User"
          ]
      }

      The query should display as follows:

      graph_post_user_property.png
    4. Select Run query.

      The new property object, "User", is added to the application. View the object details in the response:

      graph_post_user_response.png
    5. Locate the name value for the new extension property object. Copy this name value and save it in a separate location. You'll need this value to update the extension property with the specific role attribute.

      The name value for our extension property is extension_ed99f46c624143628d6641621fa593c2_tonkeanRoles.

      graph_post_user_response_name.png

      Leave Graph Explorer open in your browser tab—you'll return to it later in the process.

Add New Mapping for the Extension Property

  1. Navigate back to the {Enterprise app} | Overview screen.

  2. In the sidenav, select Provisioning. The {Enterprise app} | Provisioning screen displays.

    provisioning_select.png
  3. Select Edit attribute mappings. The Provisioning screen displays.

    provisioning_edit_attr_mappings.png
  4. Select the Mappings dropdown, then select Provision Azure Active Directory Users. The Attribute Mapping screen displays.

    provisioning_map_users_select.png
  5. Scroll to the bottom of the screen and select the Show advanced options checkbox, then select Edit attribute list for customappsso. The Edit Attribute List screen displays.

    provisioning_attr_mapping_show_advanced.png
  6. Scroll to the bottom of the screen and add a new attribute, urn:scim:tonkean, to the list with Type set to String.

    provisioning_add_attr_scim.png
  7. When finished, select Save and confirm the changes.

  8. Select Add New Mapping. The Edit Attribute screen displays.

    provisioning_attr_mapping_add_new_mapping.png
  9. Configure the attribute:

    1. Leave the Mapping type set to Direct.

    2. Select the Source attribute dropdown and select the object name of the extension property, tonkeanRoles, you created earlier. For example, our source attribute is tonkeanRoles (extension_ed99f46c624143628d6641621fa593c2_tonkeanRoles).

    3. In the Target attribute field, enter urn:scim:tonkean.

    4. When finished, select Ok. The Edit Attribute window closes.

    provisioning_edit_attr_complete.png
  10. On the Attribute Mapping screen, confirm the addition of the new mapping and select Save and confirm the changes.

    provisioning_attr_mapping_confirm_mapping___save.png

Provision Users in your Enterprise Application

Now that you have your enterprise application created and configured, you can provision users in your enterprise application.

Ensure that you've already added users to your directory before continuing this process—a user's object ID is required to provision them with the appropriate role.

Locate User Object ID

To assign the process contributor to each user, you must retrieve their Object ID.

  1. Navigate to the {Enterprise app} | Overview screen.

  2. In the sidenav, select Users and groups. The {Enterprise application} | Users and groups screen displays.

    add_roles_users_and_groups_select.png
  3. Select the user you want to assign the process contributor role to. The {User} | Profile screen displays.

    add_roles_select_user.png
  4. Locate and copy the Object ID for the user. You'll use this ID to assign the process contributor role using Graph Explorer.

    add_roles_user_obj_id_copy.png

Update the Extension Property to Assign the Process Contributor Role

For each user, you must update the tonkeanRoles extension property with a new role attribute of process contributor.

To simplify this process and allow users not already provisioned to access Tonkean, you can Automatically Assign the Process Contributor Role.

  1. Navigate back to Graph Explorer.

  2. Select PATCH in the method dropdown.

  3. Enter the following endpoint URL, replacing {user_object_id} with the Object ID value you copied for the specific user: https://graph.microsoft.com/v1.0/users/{user_object_id}

  4. In the Request body, enter the following body:

    {
        "{application_name_value}": "[PROCESS_CONTRIBUTOR]"
    }

    Replace {application_name_value} with the specific value for your application, saved in the Add the Extension Property section above. The name value for our extension property is extension_ed99f46c624143628d6641621fa593c2_tonkeanRoles.

    The query should display as follows:

    add_roles_process_contrib_query_complete.png
  5. Select Run query. If the query is successful, a No Content - 204 message displays above the Response preview.

You have successfully assigned the process contributor role to the user. You can now provision the user in the scim application itself.

Provision the User in Azure AD

  1. Navigate back to the {Enterprise application} | Overview screen.

  2. In the sidenav, select Provisioning. The {Enterprise app} | Provisioning screen displays.

    provisioning_select.png
  3. Select Provision on demand. The Provision on demand screen displays.

    add_roles_provision_on_demand.png
  4. Use the search bar to search for and select the user you want to provision. The user name displays in the Selected user field.

    add_roles_search_and_select_user.png
  5. Select Provision.

    add_roles_provision_select.png

    After processing, the user is provisioned:

    add_roles_user_provisioned_success.png

    If, as in the image above, you do not see the value of attribute urn:scim:tonkean updated to [PROCESS_CONTRIBUTOR], select Retry in the lower left. The attribute should then be updated:

    add_roles_user_provisioned_w_role.png
  6. To confirm the user is successful provisioned and granted the appropriate role, navigate to the Identity Provider screen in Tonkean and select the Provisioned Users tab. The tab should display the user and a Status of Process Contributor:

    success_tonkean_user.png
  7. Repeat each step in Provision Users in your Enterprise Application for each user you want to provision and assign the process contributor role.

You have successfully provisioned the user and assigned to them the process contributor role.