edit-icon download-icon

API overview

Last Updated: Mar 18, 2018

This page lists all of the available RAM APIs. For more OpenAPI resources, go to 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 web console logon for a RAM user
GetLoginProfile Used to view the logon configuration of a RAM user
DeleteLoginProfile Used to disable web console logon for a RAM user
UpdateLoginProfile Used to modify user logon configuration
CreateAccessKey Used to create an access key for a RAM user
UpdateAccessKey Used to change the access key status of a RAM user
DeleteAccessKey Used to delete the access key of a RAM user
ListAccessKeys Used to list the access keys of specified users
CreateVirtualMFADevice Used to create a virtual MFA device
ListVirtualMFADevices Used to list virtual MFA devices
DeleteVirtualMFADevice Used to delete virtual MFA 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 the 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 an authorization policy
GetPolicy Used to obtain information about a specified authorization policy
DeletePolicy Used to delete a specified authorization policy
ListPolicies Used to list authorization policies
CreatePolicyVersion Used to create a new authorization policy version
GetPolicyVersion Used to obtain the version information about an authorization policy
DeletePolicyVersion Used to delete a version of a specified authorization policy
ListPolicyVersions Used to list all versions of an authorization policy
SetDefaultPolicyVersion Used to set the default version of an authorization policy
AttachPolicyToUser Used to add an authorization policy to a specified user
DetachPolicyFromUser Used to remove an authorization policy from a user
AttachPolicyToGroup Used to add an authorization policy to a specified user group
DetachPolicyFromGroup Used to remove an authorization policy from a user group
AttachPolicyToRole Used to add an authorization policy to a specified role
DetachPolicyFromRole Used to remove an authorization policy from a role
ListEntitiesForPolicy Used to list the entities under an authorization policy
ListPoliciesForUser Used to list the authorization policies assigned to a specified user
ListPoliciesForGroup Used to list the authorization policies assigned to a specified user group
ListPoliciesForRole Used to list the authorization policies assigned 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 remove 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 types

Type Description
User User information
LoginProfile User logon configuration
MFADevice MFA device
VirtualMFADevice Virtual MFA device
AccessKey Access key
Group Group information
Role Role
Policy Authorization policy
PolicyVersion Authorization policy version
PasswordPolicy Password policy
SecurityPreference Security preference
Thank you! We've received your feedback.