- 01 Oct 2024
- 3 Minutes to read
- Print
- PDF
Azure User Import
- Updated on 01 Oct 2024
- 3 Minutes to read
- Print
- PDF
Azure User Import
The Graph API application in Microsoft Azure is used for gathering directory information (list of users, company, and subscription SKU info) and usage reports.
Following are the steps to configure the Graph API to get the users from Azure AD.
Prerequisites:
Given below are the mandatory key values that are required to get the data from Graph API
• Token URL
• TenantIID
• Grant_type
• Client_id
• Client_secret
• Scope
• Graph URL
Configure Azure User Import
Configuring the Azure User Import is a two-step process
- Create a Microsoft Entra ID API in API Configuration.
- Configure the Scheduler - Call API Action to schedule the activity.
To configure the Azure User Import API, perform the following steps.
1. Navigate to Design Studio > Module > API Configuration > New Figure: API Configuration - Configure the Graph API in the API Configuration. For more information refer to the table below.
Field | Description |
---|---|
API Configuration Details | The details of the API Configuration are listed here. |
API Config Name* | Select the API Config Name as Azure AD Import API. |
API Group Name* | Choose Microsoft Entra ID as the API Group Name. |
Configured For* | Choose Inbound as the option for Configured For. |
Domain* | Select the Domain for which you want the API Configured. |
Sub Domain* | Select the Sub Domain for which you want the API Configured. |
Department* | Choose the Department for which the API is configured. |
Active | Enable the Active switch to keep the API Configuration active. |
Icon | Choose an icon to be uploaded for the specified API.
|
API Details | The API Details are given below. |
API Name* | The API Name is auto-selected when the API Group Name is chosen as Microsoft Entra ID. |
API Timeout (In seconds)* | Choose a numeral for specifying the timeout (In seconds) |
API Type* | The API Type gets updated as External when the API Group Name is chosen as Microsoft Entra ID. |
Response Type* | The Response Type gets auto-populated as an Array |
Pagination Link | The Pagination Link is updated as Content when the API Group Name is chosen as Microsoft Entra ID |
Attribute Name | The Attribute Name also gets auto updated when the API Group Name is chosen as Microsoft Entra ID |
List the response attributes with hierarchy | This switch is enabled to view nested API response attributes or disable to view only the first level attributes. |
Method* | The Method is auto-populated as Get for the configured API when the API Group Name is chosen as Microsoft Entra ID |
URL | The URL get auto-populated when the API Group Name is chosen as Microsoft Entra ID |
Authentication | The Authentication Type has to be selected as Oauth 2.0. The following fields will get displayed. Grant Type - This is the method used by the client application to obtain an access token from the authorization server. Token URL - This is the endpoint on the authorization server where the client application can exchange an authorization grant (such as an authorization code or user credentials) for an access token. Client ID - This is a unique identifier assigned to a client application when it is registered with the authorization server. Client Secret - This is a piece of confidential information known only to the OAuth client (typically an application or service) and the authorization server. Scope - This is a parameter used by the client application to specify the access rights it requests from the user's account on the resource server. |
Params | The parameters need not be set. |
Header | The header need not be set. |
Body | The request type can be viewed in Text, JSON, or XML format. |
Response | The response can be viewed here. |
Configured API | The configured APIs are listed here. Refer to the image below. |
- Click Send to test the API and check the Response Body.
2. Configure the job in Scheduler using the configured API for the User table.
- Navigate to Design Studio > Application > Scheduler > New.
- In the general stepper, configure the below fields. Choose the Scheduler Type as Custom and Table as User and Execute at Web Server.
- Set the required number of times the scheduler needs to run in the Frequency step.
- No conditions are specified in the Condition step.
- In the Actions step, go to Call API.
- In the Call API action, select the Inbound type and map the necessary columns and Publish the Scheduler.
For more information, refer to the table below.
Field | Description |
---|---|
Action Type* | Select the Action Type as Inbound |
Target Action* | The Target Action to be achieved using the API can be selected as Create Record, and Update Record. |
API | Choose Azure User Import from the dropdown as the Graph API configured in API Configuration. |
Process Type | Choose Bulk Request from the drop-down menu as |
Send Request | |
Column Mapping | Map the columns of the User master with the corresponding columns in the AD Import Note Azure AD only supports Email ID to be set as unique. User Name mapping is mandatory. |
4. Verify the data post-import.
- Navigate to Platform Studio > User Access Management > User. Open the user from the list page.