API概览

本产品(Ims/2019-08-15)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

用户管理

API

标题

API概述

用户 用户
CreateUser 创建RAM用户 创建RAM用户。
GetUser 查询RAM用户的详细信息 查询指定的RAM用户的详细信息。
UpdateUser 修改RAM用户信息 调用UpdateUser修改RAM用户信息。
DeleteUser 删除RAM用户 删除指定的RAM用户。
ListUsers 查询所有RAM用户的详细信息 查询所有RAM用户的详细信息。
ListUserBasicInfos 查询所有RAM用户的基本信息 调用ListUserBasicInfos查询所有RAM用户的基本信息。
GetAccountSummary 查询主账号概览信息 查询阿里云账号(主账号)的概览信息。
登录信息 登录信息
CreateLoginProfile 开启指定RAM用户的控制台登录 RAM用户创建登录配置。
GetLoginProfile 查询指定RAM用户的登录信息 查询指定RAM用户的登录信息。
UpdateLoginProfile 修改RAM用户的控制台登录信息 修改指定RAM用户的控制台登录信息。
DeleteLoginProfile 关闭指定RAM用户的控制台登录 删除RAM用户的控制台登录配置。
ChangePassword RAM用户修改自己的登录密码 RAM用户为自己修改控制台登录密码。
访问密钥 访问密钥
CreateAccessKey 创建主账号或RAM用户访问密钥 创建阿里云账号(主账号)或RAM用户的访问密钥。
DeleteAccessKey 删除用户的访问密钥 删除阿里云账号(主账号)或RAM用户的访问密钥。
UpdateAccessKey 修改访问密钥状态 修改阿里云账号(主账号)或RAM用户的访问密钥状态。
GetAccessKeyLastUsed 查询指定访问密钥的最后使用时间 查询某个指定访问密钥的最后使用时间。
ListAccessKeys 查询主账号或RAM用户访问密钥列表 查询阿里云账号(主账号)或RAM用户的访问密钥列表。
多因素认证 多因素认证
GetVerificationInfo 获取用户手机邮箱的安全认证信息 查询RAM用户的安全手机或安全邮箱状态。
CreateVirtualMFADevice 创建多因素认证设备 创建一个虚拟多因素认证设备。
ListVirtualMFADevices 查询多因素认证设备列表 查询多因素认证设备列表。
DeleteVirtualMFADevice 删除多因素认证设备 删除指定的多因素认证设备。
DisableVirtualMFA 解绑并删除多因素认证设备 解绑并删除一个指定RAM用户的多因素认证设备。
BindMFADevice RAM用户绑定多因素认证设备 RAM用户绑定指定的多因素认证设备。
UnbindMFADevice RAM用户解绑多因素认证设备 RAM用户解绑定多因素认证设备。
GetAccountMFAInfo 查询主账号多因素认证设备信息 查询阿里云账号(主账号)的多因素认证设备信息。
GetUserMFAInfo 查询RAM用户多因素认证设备信息 查询指定RAM用户的多因素认证设备信息。
SetVerificationInfo RAM用户绑定安全手机或安全邮箱 RAM用户绑定安全手机或安全邮箱。
UnbindVerification RAM用户解绑安全手机或安全邮箱 RAM用户解绑安全手机或安全邮箱。
标签 标签
TagResources 资源打上标签 调用TagResources接口给资源打上标签。
UntagResources 解绑资源的标签 调用UntagResources接口解绑资源的标签。
ListTagResources 查询资源与标签的关系 调用ListTagResources查询资源与标签的关系。
通行密钥 通行密钥
UpdatePasskey 更新通行密钥 更新通行密钥。
ListPasskeys 查看用户绑定的通行密钥 查询用户绑定的通行密钥信息。
DeletePasskey 删除通行密钥 删除用户的通行密钥。
回收站 回收站
ListUsersInRecycleBin 查询回收站中的所有RAM用户 查询回收站中的所有RAM用户的基本信息。
GetUserInRecycleBin 查询回收站中的RAM用户 查询回收站中的指定RAM用户信息。
DeleteUserInRecycleBin 删除回收站中的RAM用户 删除回收站中的指定RAM用户。
RestoreUserFromRecycleBin 从回收站中恢复RAM用户 从回收站中恢复指定RAM用户。
ListAccessKeysInRecycleBin 查询回收站中的访问密钥列表 查询回收站中的指定RAM用户的访问密钥列表。
GetAccessKeyInfoInRecycleBin 查询回收站中的访问密钥 查询回收站中的归属于RAM用户的指定访问密钥信息。
DeleteAccessKeyInRecycleBin 删除回收站中的访问密钥 删除回收站中归属于指定RAM用户的指定访问密钥。
RestoreAccessKeyFromRecycleBin 从回收站中恢复访问密钥 从回收站中恢复归属于指定RAM用户的指定访问密钥。

用户组管理

API

标题

API概述

CreateGroup 创建用户组 创建一个用户组。
GetGroup 查询指定用户组信息 查询指定的用户组信息。
UpdateGroup 修改指定用户组的信息 修改指定用户组的基础信息。
DeleteGroup 删除指定的用户组 删除一个指定的用户组。
ListGroups 查询用户组列表 列出用户组的信息列表。
AddUserToGroup RAM用户添加到指定的用户组 将指定的RAM用户添加到指定的用户组。
RemoveUserFromGroup RAM用户从用户组中移除 将指定RAM用户从指定用户组中移除。
ListUsersForGroup 查询用户组内的RAM用户列表 查询指定用户组内的RAM用户列表。
ListGroupsForUser 查询RAM用户加入的用户组列表 查询指定的RAM用户加入的组的列表。

单点登录(SSO)管理

API

标题

API概述

SetUserSsoSettings 设置用户SSO身份提供商信息 设置用户SSO的身份提供商信息。
GetUserSsoSettings 查询用户SSO身份提供商信息 查询用户SSO身份提供商配置信息。
CreateSAMLProvider 创建角色SSO身份提供商 创建一个角色SSO的身份提供商配置。
DeleteSAMLProvider 删除指定的角色SSO身份提供商 删除一个角色SSO的身份提供商配置。
UpdateSAMLProvider 修改角色SSO身份提供商信息 修改指定的角色SSO身份提供商信息。
GetSAMLProvider 查询角色SSO身份提供商信息 查询指定的角色SSO身份提供商信息。
ListSAMLProviders 查询角色SSO身份提供商列表 查询所有角色SSO身份提供商信息。
CreateOIDCProvider 创建OIDC身份供应商 调用CreateOIDCProvider创建OIDC身份提供商,配置阿里云与外部身份提供商(IdP)的信任关系。
GetOIDCProvider 查询OIDC身份提供商信息 调用GetOIDCProvider查询OIDC身份提供商信息。
UpdateOIDCProvider 修改OIDC身份提供商 调用UpdateOIDCProvider修改OIDC身份提供商的描述和客户端ID。
ListOIDCProviders 查询OIDC身份提供商列表 调用ListOIDCProviders查询OIDC身份提供商列表。
DeleteOIDCProvider 删除OIDC身份提供商 调用DeleteOIDCProvider删除OIDC身份提供商。
AddClientIdToOIDCProvider OIDC身份提供商添加指定客户端ID 调用AddClientIdToOIDCProviderOIDC身份提供商添加指定客户端ID。
RemoveClientIdFromOIDCProvider 移除OIDC身份提供商中的指定客户端ID 调用RemoveClientIdFromOIDCProvider移除OIDC身份提供商中的指定客户端ID。
AddFingerprintToOIDCProvider OIDC身份提供商添加验证指纹 调用AddFingerprintToOIDCProviderOIDC身份提供商添加验证指纹。
RemoveFingerprintFromOIDCProvider 移除OIDC身份提供商中指定的验证指纹 调用RemoveFingerprintFromOIDCProvider移除OIDC身份提供商中指定的验证指纹。

开放授权(OAuth)管理

API

标题

API概述

CreateApplication 创建应用 创建一个应用。
GetApplication 查询应用的配置信息 查询指定应用的配置信息。
UpdateApplication 修改应用的配置信息 修改指定应用的配置信息。
DeleteApplication 删除一个应用 删除指定的应用。
ListApplications 查询应用列表 列出创建的应用列表。
ListPredefinedScopes 查询系统预设的Scope列表 列出系统预定义的应用权限范围列表。
CreateAppSecret 为指定的应用创建应用密钥 为指定的应用创建一个应用密钥。
GetAppSecret 查询指定应用密钥信息 查询指定应用的密钥信息。
ListAppSecretIds 查询指定应用的应用密钥ID列表 列出指定应用的应用密钥信息列表。
DeleteAppSecret 删除指定应用的应用密钥 删除指定的应用密钥。
ProvisionApplication 安装应用 安装应用。
DeprovisionApplication 卸载已安装的应用 卸载已安装的外部应用,或内部应用中的ServerApp类型应用。
ListApplicationProvisionInfos 查询所有已安装应用的安装信息 查询所有已安装应用的安装信息。
GetApplicationProvisionInfo 查询应用安装信息 查询指定的已安装应用的安装信息。
ProvisionExternalApplication 安装外部应用 安装外部应用。
DeprovisionExternalApplication 卸载已安装的外部应用 卸载已安装的外部应用。
ListExternalApplications 查询所有已安装的外部应用 查询所有已安装的外部应用的信息。
GetExternalApplication 查询外部应用信息 查询已安装的外部应用的信息。

安全设置

API

标题

API概述

SetPasswordPolicy 设置RAM用户密码强度策略 设置RAM用户的密码强度策略。
GetPasswordPolicy 查询RAM用户密码强度策略信息 查询RAM用户的密码强度策略信息。
SetSecurityPreference 设置RAM用户的全局安全首选项 设置RAM用户的全局安全首选项信息。
GetSecurityPreference 查询RAM用户全局安全首选项 调用GetSecurityPreference查询RAM用户的全局安全首选项。
SetDefaultDomain 设置默认域名 为阿里云账号(主账号)设置默认域名。
GetDefaultDomain 查询默认域名 查询阿里云账号(主账号)下的默认域名。
GetCredentialReport 查询用户凭证报告内容 查询阿里云账号(主账号)下的用户凭证报告。
GetAccountSecurityPracticeReport 查询阿里云账号的安全报告 获取阿里云账号(主账号)下的用户凭证报告。
GenerateCredentialReport 生成用户凭证报告 生成阿里云账号(主账号)下的用户凭证报告。

身份权限治理

API

标题

API概述

GenerateGovernanceReport 生成身份权限治理检测报告 生成身份权限治理检测报告。
GetGovernanceReportStatus 查询身份权限治理检测报告生成状态 获取身份权限治理检测报告当前的生成状态。
GetGovernanceItemReport 查询身份权限指定治理检测项检测报告 查询身份权限治理检测报告中指定治理检测项的信息。
ListRecentGovernanceMetrics 查询最近一次治理检测的所有治理项指标值 查询最近一次治理检测中的所有检测指标值。