Adapter - Microsoft Office 365 - Azure Active Directory
This page describes version 2.0.3 of the adapter.
Overview
This adapter is used to perform Azure Active Directory users searches.
Configuration
This adapter requires a tenantId and clientId and clientSecret. These can be created on the Azure portal page.
Warning
- When using this adapter, it is necessary to register the application to access Azure Active Directory and read the user attributes.
- It is necessary to grant the permission "User.Read.All" to the registered application to read the attributes of the user.
- To get all user data registered in Azure Active Directory, set getAll of the input property of the "listUser" command to true. The maximum number of users that can be get by setting this property is 1000. It takes about 5 seconds to get 1000 records. Consult NEC if all user data exceeds 1000.
- The default attributes to get with the listUser command are 'businessPhones', 'displayName', 'givenName', 'id', 'jobTitle', 'mail', 'mobilePhone', 'officeLocation', 'preferredLanguage', 'surname', ' userPrincipalName'.
- Specify the OData property when you want to get attributes other than the default with the listUser command, or when you perform filter, sort, etc. Please refer to the following Microsoft page for how to use OData.
- Cannot use & or = in OData $filter. Also, ' needs to be escaped like ''.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| tenantId | Tenant ID | True | An identifier for identifying the tenant. You can find your Tenant ID on the Azure portal page. | string | |||||
| clientId | Client ID | True | An identifier for identifying the client application. You can find your Client ID on the Azure portal page. | string | |||||
| clientSecret | Client Secret | True | The client application private key. You can find the Client Secret on the Azure portal page. | password |
Commands
Search (listUser)
Searches the directory in Azure Active Directory using the specified OData query
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| getAll | Get all | Set to true to get all user data registered in Azure Active Directory. | False | boolean |
| odata | OData | Set the OData query | False | string |
| phoneNumber | Phone Number | Specify the extension number or extension number when filtering with the businessPhones or mobilePhone attributes that do not support $filter of OData query. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| value | Specify as value [n].[attribute name]. Not output if the attribute value is null. | array |
| codenum | '1' Authentication error, '2' System error, '3' Graph API call error | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.2 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.3 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |