This product(
Eiam-developerapi/2022-02-25) OpenAPI adopts ROA Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
OIDC API
| API | Title | Description |
|---|---|---|
| GenerateToken | GenerateToken | Generates a token for accessing an application in an instance. |
| GenerateDeviceCode | GenerateDeviceCode | Generates a device code. |
| GetUserInfo | GetUserInfo | Queries the information of a user by using the user token. |
| RevokeToken | RevokeToken | Revokes an access token or refresh token. |
Provisioning Scope
| API | Title | Description |
|---|---|---|
| GetApplicationProvisioningScope | GetApplicationProvisioningScope | Queries the synchronization scope of an application in an instance. |
Organization
| API | Title | Description |
|---|---|---|
| CreateOrganizationalUnit | CreateOrganizationalUnit | Creates an organizational unit. |
| PatchOrganizationalUnit | PatchOrganizationalUnit | Modifies an EIAM organizational unit. |
| GetOrganizationalUnit | GetOrganizationalUnit | Queries the information of an organizational unit. |
| DeleteOrganizationalUnit | DeleteOrganizationalUnit | Deletes an organizational unit. |
| ListOrganizationalUnits | ListOrganizationalUnits | Queries the information of Employee Identity and Access Management (EIAM) organizational units by page. |
| ListOrganizationalUnitParentIds | ListOrganizationalUnitParentIds | Queries the information of all the parent organizational units of an organizational unit. |
| GetOrganizationalUnitIdByExternalId | GetOrganizationalUnitIdByExternalId | Obtains the ID of an organizational unit based on the external ID |
User
| API | Title | Description |
|---|---|---|
| CreateUser | CreateUser | Creates an Employee Identity and Access Management (EIAM) account in an organizational unit. |
| PatchUser | PatchUser | Modifies an Employee Identity and Access Management (EIAM) account. |
| GetUser | GetUser | Queries the information of an Employee Identity and Access Management (EIAM) account. |
| DeleteUser | DeleteUser | Deletes an Employee Identity and Access Management (EIAM) account. |
| ListUsers | ListUsers | Queries the information of Employee Identity and Access Management (EIAM) accounts by page. |
| EnableUser | EnableUser | Enables an Employee Identity and Access Management (EIAM) account. |
| DisableUser | DisableUser | Disables an Employee Identity and Access Management (EIAM) account. |
| GetUserIdByEmail | GetUserIdByEmail | Queries the ID of an Employee Identity and Access Management (EIAM) account by email address. |
| GetUserIdByPhoneNumber | GetUserIdByPhoneNumber | Queries the ID of an Employee Identity and Access Management (EIAM) account based on the mobile number. |
| GetUserIdByUserExternalId | GetUserIdByUserExternalId | Queries the ID of an Employee Identity and Access Management (EIAM) account based on the external ID. |
| GetUserIdByUsername | GetUserIdByUsername | Queries the ID of an Employee Identity and Access Management (EIAM) account based on the username. |