This topic lists all RAM APIs. For more information about OpenAPI resources, see API Explorer.
User management APIs
| API | Description |
|---|---|
| CreateUser | Used to create a RAM user |
| GetUser | Used to obtain user details |
| UpdateUser | Used to update basic user information |
| DeleteUser | Used to delete a RAM user |
| ListUsers | Used to list all RAM users |
| CreateLoginProfile | Used to enable console logon for a RAM user |
| GetLoginProfile | Used to view the logon configurations of a RAM user |
| DeleteLoginProfile | Used to disable console logon for a RAM user |
| UpdateLoginProfile | Used to modify user logon configurations |
| CreateAccessKey | Used to create an AccessKey (AK) for a RAM user |
| UpdateAccessKey | Used to change the AK status of a RAM user |
| DeleteAccessKey | Used to delete the AK of a RAM user |
| ListAccessKeys | Used to list the AK of s specified user |
| CreateVirtualMFADevice | Used to create a virtual MFA (VMFA) device |
| ListVirtualMFADevices | Used to list VMFA devices |
| DeleteVirtualMFADevice | Used to delete VMFA devices |
| BindMFADevice | Used to bind an MFA device |
| UnbindMFADevice | Used to unbind an MFA device |
| GetUserMFAInfo | Used to obtain the MFA device bound to a specified RAM user |
| ChangePassword | Used to change the password for a RAM user |
Group management APIs
| API | Description |
|---|---|
| CreateGroup | Used to create a user group |
| GetGroup | Used to obtain user group information |
| UpdateGroup | Used to update user group information |
| ListGroups | Used to list all user groups |
| DeleteGroup | Used to delete a specified user group |
| AddUserToGroup | Used to add RAM users to a specified user group |
| RemoveUserFromGroup | Used to remove a RAM user from a user group |
| ListGroupsForUser | Used to list information about the group to which a specified RAM user is added |
| ListUsersForGroup | Used to list the RAM users included in a specified user group |
Role management APIs
| API | Description |
|---|---|
| CreateRole | Used to create a role |
| GetRole | Used to obtain role information |
| UpdateRole | Used to update role information |
| ListRoles | Used to list roles |
| DeleteRole | Used to delete a specified role |
Authorization policy management APIs
| API | Description |
|---|---|
| CreatePolicy | Used to create a policy |
| GetPolicy | Used to obtain information about a specified policy |
| DeletePolicy | Used to delete a specified policy |
| ListPolicies | Used to list policies |
| CreatePolicyVersion | Used to create a new policy version |
| GetPolicyVersion | Used to obtain the version of a policy |
| DeletePolicyVersion | Used to delete a version of a specified policy |
| ListPolicyVersions | Used to list all versions of a policy |
| SetDefaultPolicyVersion | Used to set the default version of a policy |
| AttachPolicyToUser | Used to add a policy to a specified user |
| DetachPolicyFromGroup | Used to remove a policy from a user |
| AttachPolicyToGroup | Used to add a policy to a specified user group |
| DetachPolicyFromRole | Used to remove a policy from a user group |
| AttachPolicyToRole | Used to add a policy to a specified role |
| DetachPolicyFromRole | Used to remove a policy from a role |
| ListEntitiesForPolicy | Used to list the entities using a policy |
| ListPoliciesForUser | Used to list the policies granted to a specified user |
| ListPoliciesForGroup | Used to list the policies granted to a specified user group |
| ListPoliciesForRole | Used to list the policies granted to a specified role |
Security setting APIs
| API | Description |
|---|---|
| SetAccountAlias | Used to set a cloud account alias |
| GetAccountAlias | Used to view a cloud account alias |
| ClearAccountAlias | Used to delete a cloud account alias |
| SetPasswordPolicy | Used to set the password policy for a user, including the password strength |
| GetPasswordPolicy | Used to obtain the password policy of a user, including the password strength |
| SetSecurityPreference | Used to set the global security preferences |
Data type
| Type | Description |
|---|---|
| User | User information |
| LoginProfile | User logon configurations |
| MFADevice | MFA device |
| VirtualMFADevice | VMFA device |
| AccessKey | AK |
| Group | Group information |
| Role | Role |
| Policy | Policy |
| PolicyVersion | Policy version |
| PasswordPolicy | Password policy |
| SecurityPreference | Security preference |