This topic describes the basic information about Resource Access Management (RAM) APIs. For more information about Alibaba Cloud APIs, see Overview.
Overview
RAM APIs include the Identity Management Service (IMS) API, RAM API, and Security Token Service (STS) API.
You can call the APIs based on your business requirements. The following table describes the details of the APIs.
Scenario | Description | API selection | Difference |
User management | Manage RAM users, AccessKey pairs, logon passwords, and multi-factor authentication (MFA) devices. |
| |
User group management | Manage RAM user groups, and add or remove RAM users in RAM user groups. | ||
Security settings | Manage password policies, global security preferences, default domain names, user credential reports, and security reports of Alibaba Cloud accounts. | ||
Policy management | Manage policies and grant permissions to or revoke permissions from a RAM user, RAM role, or RAM user group. |
| |
Role management | Manage RAM roles. | ||
Role usage | Obtain STS tokens by assuming roles. | None. | |
Single sign-on (SSO) management | Manage identity providers (IdPs) for user-based SSO and role-based SSO. | None. | |
Role-based SSO usage | Obtain STS tokens by using role-based SSO. | None. | |
Open authorization (OAuth) management | Manage applications and application secrets. | None. |
IMS API
API versions
API version | Description |
We recommend that you use this version. |
Endpoints
For more information, see Endpoints.
User identities
User identity | Supported |
Yes | |
RAM user (recommended) | Yes |
RAM role (recommended) | Yes |
We recommend that you use a RAM user or RAM role to call operations. Before you use a RAM user or RAM role to call operations, you must grant the required permissions to the RAM user or RAM role.
Format
Call methods
Call method | Supported | Description |
Alibaba Cloud SDK (recommended) | Yes | For more information about the programming languages supported by IMS SDKs and methods to install dependencies, see IMS SDKs. |
Yes | None. | |
Partially supported | For more information, see Terraform Registry. | |
Partially supported | For more information, see List of resource types by service. | |
Yes | None. |
RAM API
API versions
API version | Description |
We recommend that you use this version. |
Endpoints
For more information, see Endpoints.
User identities
User identity | Supported |
Yes | |
RAM user (recommended) | Yes |
RAM role (recommended) | Yes |
We recommend that you use a RAM user or RAM role to call operations. Before you use a RAM user or RAM role to call operations, you must grant the required permissions to the RAM user or RAM role.
Format
RPC API
Call methods
Call method | Supported | Description |
Alibaba Cloud SDK (recommended) | Yes | For more information about the programming languages supported by RAM SDKs and methods to install dependencies, see RAM SDKs. |
Yes | None. | |
Partially supported | For more information, see Terraform Registry. | |
Partially supported | For more information, see List of resource types by service. | |
Yes | None. |
STS API
API versions
API version | Description |
We recommend that you use this version. |
Endpoints
For more information, see Endpoints.
User identities
Interface | Supported user identity |
Authentication for this operation is performed based on SAML assertions. Anonymous users can call this operation. | |
Authentication for this operation is performed based on OIDC tokens. Anonymous users can call this operation. | |
Format
RPC API
Call methods
Call method | Supported | Description |
Alibaba Cloud SDK (recommended) | Yes | For more information about the programming languages supported by STS SDKs and methods to install dependencies, see STS SDKs. |
Yes | None. | |
Yes | None. | |
Not Supported. | None. | |
Yes | None. |