API standard and pre-built SDKs in multi-language
This product (eds-user/2021-03-08) OpenAPI adopts an RPC-style signature mechanism. For implementation details, please refer to the Signature Mechanism documentation.To streamline development, we provide official SDKs for major programming languages. Using the SDK allows you to call APIs directly without worrying about low-level details such as request signatures, significantly lowering the barrier to entry and reducing integration complexity.
Custom signature
If your use case requires direct API integration with custom signatures, consult our technical support team first. Join our DingTalk support group (147535001692) to receive expert guidance.
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Login
| API | Title | Description |
|---|---|---|
| InitTenantAlias | InitTenantAlias | Initializes an organization ID. |
User
| API | Title | Description |
|---|---|---|
| CreateUsers | CreateUsers | Creates a convenience user. |
| RemoveUsers | RemoveUsers | Removes one or more convenience users. |
| ModifyUser | ModifyUser | Updates the contact information of a convenience account. |
| ResetUserPassword | ResetUserPassword | Resets the password for a convenience user. If you call this operation, a token that is used to reset the password is generated, and the system sends a password reset email that includes the token to the email address of the convenience user. |
| LockUsers | LockUsers | Locks one or more convenience users. |
| UnlockUsers | UnlockUsers | Unlocks one or more convenience users. |
| DescribeUsers | DescribeUsers | Queries the information about convenience users. The information of a convenience user includes a username, an email address, and a description. |
| FilterUsers | FilterUsers | Filters convenience accounts by property. |
| GetManagerInfoByAuthCode | GetManagerInfoByAuthCode | Obtains the information about the current logon administrator based on the authorization code. |
User property
| API | Title | Description |
|---|---|---|
| CreateProperty | CreateProperty | Creates a user property. |
| RemoveProperty | RemoveProperty | Deletes a user property. |
| DeleteUserPropertyValue | DeleteUserPropertyValue | Dissociates a user property from a user. |
| UpdateProperty | UpdateProperty | Modifies a user property. |
| SetUserPropertyValue | SetUserPropertyValue | Associates a user property with a convenience user. |
| ListProperty | ListProperty | Queries all user properties within an Alibaba Cloud account. |
| ListPropertyValue | ListPropertyValue | Queries property values of a user property. |
| CheckUsedProperty | CheckUsedProperty | Queries whether a property is associated with one or more convenience users. |
| CheckUsedPropertyValue | CheckUsedPropertyValue | Queries the number of convenience accounts that are associated with the specified custom property value. |
Organisation
| API | Title | Description |
|---|---|---|
| CreateOrg | CreateOrg | Creates an organization. |
| DescribeOrgs | DescribeOrgs | Queries organizations. |
| DescribeOrgByLayer | DescribeOrgByLayer | Queries subordinate organizations. |
| RemoveOrg | RemoveOrg | Removes an organization. |
| MoveOrg | MoveOrg | Moves an organization. |
| ModifyOrg | ModifyOrg | Modifies an organization. |
| MoveUserOrg | MoveUserOrg | Moves users to a specific organization. |
User Group
| API | Title | Description |
|---|---|---|
| CreateGroup | CreateGroup | Creates a user group. |
| DescribeGroups | DescribeGroups | Queries user groups. |
| UserBatchQuitGroup | UserBatchQuitGroup | Removes multiple users from a user group at a time. |
| UserBatchJoinGroup | UserBatchJoinGroup | Add multiple users to a user group at a time. |
| RemoveGroup | RemoveGroup | Deletes a single user group or multiple user groups at a time. |
| ModifyGroup | ModifyGroup | Modifies the name and description of a user group. |
| DescribeGroupUser | DescribeGroupUser | Queries the members of a user group. |
Resource Group
| API | Title | Description |
|---|---|---|
| CreateResourceGroup | CreateResourceGroup | Creates a resource group. |
| DeleteResourceGroup | DeleteResourceGroup | Deletes a resource group. |
| DescribeResourceGroups | DescribeResourceGroups | Queries resource groups. |