文档

API概览

更新时间:
本产品(云身份服务 (IDaaS EIAM)/2021-12-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

地域

API标题API概述
ListRegions查询EIAM支持的地域列表查询支持的阿里云地域列表。

实例管理

API标题API概述
CreateInstance创建一个EIAM实例创建一个实例,EIAM所有产品能力都基于实例来提供。
DeleteInstance删除一个EIAM实例删除一个您不再使用的EIAM实例。
UpdateInstanceDescription更新EIAM实例描述信息修改指定EIAM实例的描述信息。
ListInstances列表查询EIAM实例查询一个或者多个EIAM实例信息。
GetInstance查询单个EIAM实例查询一个EIAM实例的详细信息。
EnableInitDomainAutoRedirect开启EIAM实例由初始化域名自动跳转到默认域名开启EIAM实例由初始化域名自动跳转到默认域名,开启后,通过初始化域名访问门户业会跳转到默认域名地址。
DisableInitDomainAutoRedirect关闭EIAM实例由初始化域名自动跳转到默认域名关闭EIAM实例由初始化域名自动跳转到默认域名,关闭后,通过初始化域名访问门户业不会跳转到默认域名。

域名管理

API标题API概述
GetDomainDnsChallenge查询EIAM域名的DNS Challenge记录查询指定EIAM域名的DNS Challenge记录,生成的记录用于做域名的所有权校验。
CreateDomain创建EIAM实例自定义域名创建EIAM实例的自定义域名。
GetDomain查询EIAM实例的域名信息查询EIAM实例的域名信息。
SetDefaultDomain设置指定EIAM实例域名为默认域名将指定EIAM实例域名设置为默认域名。
ListDomains列表查询EIAM实例的域名信息列表查询EIAM实例的域名信息,列表中包含实例初始化域名和自定义域名。
DeleteDomain删除指定的EIAM实例自定义域名删除指定的EIAM实例自定义域名,实例初始化域名和默认域名的删除操作会被拒绝。
CreateDomainProxyToken创建EIAM实例域名的代理Token创建EIAM实例域名的代理Token。
ObtainDomainProxyToken查询EIAM实例域名的代理Token信息查询EIAM实例域名的代理Token。
EnableDomainProxyToken启用指定EIAM实例域名代理Token启用指定EIAM实例域名代理Token,用于校验域名安全性。
DisableDomainProxyToken禁用指定EIAM实例域名代理Token禁用指定EIAM实例域名代理Token,禁用之后,域名使用会受影响。
ListDomainProxyTokens列表查询EIAM实例域名的代理Token列表查询EIAM实例域名的代理Token。
DeleteDomainProxyToken删除指定EIAM实例域名的代理Token删除指定EIAM实例域名的代理Token,处于禁用状态的代理Token才能被删除。

应用管理

API标题API概述
应用基本信息管理应用基本信息管理
CreateApplication创建一个EIAM应用在指定EIAM实例下创建一个应用资源。
DeleteApplication删除一个EIAM应用删除一个EIAM应用资源。
UpdateApplicationDescription更新一个EIAM应用的描述信息更新一个EIAM应用的描述信息。
EnableApplication启用一个EIAM应用将一个应用从禁用状态变为启用状态。
DisableApplication禁用一个EIAM应用将一个应用从启用状态变为禁用状态,此时应用全部能力不可用。
GetApplication查询一个EIAM应用的详细信息获取指定EIAM应用的详细信息。
ListApplications列表查询EIAM应用分页查询一个或者多个EIAM应用信息。
应用SSO配置管理应用SSO配置管理
EnableApplicationSso启用一个EIAM应用SSO功能启用一个EIAM应用的SSO功能。
DisableApplicationSso禁用一个EIAM应用的SSO功能禁用一个EIAM应用的SSO单点登录功能,此时应用不支持员工单点登录。
SetApplicationSsoConfig设置一个EIAM应用的单点登录SSO配置设置一个EIAM应用的单点登录SSO配置属性。
GetApplicationSsoConfig查询一个EIAM应用的单点登录SSO配置查询一个EIAM应用的单点登录SSO配置属性。
应用授权管理应用授权管理
AuthorizeApplicationToUsers授予多个EIAM账户访问一个应用的权限批量授予多个EIAM账户访问一个应用的权限。
AuthorizeApplicationToOrganizationalUnits授予多个EIAM组织访问一个应用的权限批量授予多个EIAM组织访问一个应用的权限。
AuthorizeApplicationToGroups授予多个EIAM组访问一个应用的权限批量授予多个EIAM组访问一个应用的权限。
RevokeApplicationFromUsers取消多个EIAM账户访问一个应用的权限批量取消多个EIAM账户访问一个应用的权限。
RevokeApplicationFromOrganizationalUnits取消多个EIAM组织访问一个应用的权限批量取消多个EIAM组织访问一个应用的权限。
RevokeApplicationFromGroups取消多个EIAM组访问一个应用的权限批量取消多个EIAM组访问一个应用的权限。
UpdateApplicationAuthorizationType更改一个应用的访问授权类型更改指定EIAM应用的访问授权类型。
ListUsersForApplication查询一个EIAM应用被授权访问的账户列表分页查询一个应用被授权访问的账户列表,返回的结果中,包含账户ID信息,如需获取账户详细信息,请调用GetUser接口。
ListOrganizationalUnitsForApplication查询一个EIAM应用被授权访问的组织列表分页查询一个应用被授权访问的组织列表,返回的结果中,包含组织ID信息,如需获取组织详细信息,请调用GetOrganizationalUnit接口。
ListGroupsForApplication查询一个EIAM应用被授权访问的组列表分页查询一个应用被授权访问的组列表,返回的结果中,包含组ID信息,如需获取组详细信息,请调用GetGroup接口。
ListApplicationsForUser查询一个EIAM账户可访问的应用列表信息分页查询一个EIAM账户可访问的应用列表,返回的结果中,包含应用ID信息,如需获取应用详细信息,请调用GetApplication接口。
ListApplicationsForOrganizationalUnit查询一个EIAM组织可访问的应用列表信息分页查询一个EIAM组织可访问的应用列表,返回的结果中,包含应用ID信息,如需获取应用详细信息,请调用GetApplication接口。
应用ClientSecret管理应用ClientSecret管理
CreateApplicationClientSecret创建一个EIAM应用的客户端密钥创建一个EIAM应用的客户端密钥,一个EIAM应用下,最多只能创建两个应用的客户端密钥。
DeleteApplicationClientSecret删除一个EIAM应用的客户端密钥删除一个EIAM应用的客户端密钥。
DisableApplicationClientSecret禁用一个EIAM应用的客户端密钥禁用一个EIAM应用的客户端密钥。
EnableApplicationClientSecret启用一个EIAM应用的客户端密钥启用一个EIAM应用的客户端密钥。
ListApplicationClientSecrets查询一个EIAM应用所属的全部客户端密钥查询一个EIAM应用所属的全部客户端密钥,返回的密钥数据已脱敏,若需要获取未脱敏密钥,请调用ObtainApplicationClientSecret接口。
ObtainApplicationClientSecret查询一个EIAM应用的客户端密钥获取EIAM应用的客户端密钥,返回的密钥未脱敏。若需要获取已脱敏密钥,请调用ListApplicationClientSecrets接口。
应用API开放应用API开放
EnableApplicationApiInvoke启用一个EIAM应用的Developer API调用功能调用EnabledApplicationApiInvoke接口启用一个EIAM应用的Developer API调用功能。
DisableApplicationApiInvoke禁用一个EIAM应用的Developer API调用能力禁用一个EIAM应用的Developer API调用功能。
SetApplicationGrantScope设置一个EIAM应用的Developer API授权范围设置一个EIAM应用的Developer API授权范围。
GetApplicationGrantScope查询一个EIAM应用的Developer API授权范围查询一个EIAM应用的Developer API授权范围。
应用账户同步应用账户同步
DisableApplicationProvisioning禁用一个EIAM应用的账户同步功能禁用一个EIAM应用的账户同步功能。
EnableApplicationProvisioning启用一个EIAM应用的账户同步功能启用一个EIAM应用的账户同步功能。
SetApplicationProvisioningConfig设置一个EIAM应用的账户同步功能配置设置一个EIAM应用的账户同步功能配置。
SetApplicationProvisioningScope设置一个EIAM应用的账户同步范围设置一个EIAM应用的账户同步范围,该账户同步范围同时为DeveloperAPI可以查询和管理的账户范围。
GetApplicationProvisioningConfig查询一个EIAM应用的账户同步功能配置查询一个EIAM应用的账户同步功能配置。
GetApplicationProvisioningScope查询一个EIAM应用的账户同步范围查询EIAM应用的账户同步范围,该账户同步范围同时为DeveloperAPI可以查询和管理的账户范围。

账户管理

API标题API概述
CreateUser创建一个EIAM账户在指定EIAM实例下创建一个EIAM账户。
AddUserToOrganizationalUnits将一个EIAM账户加入到多个EIAM组织将指定EIAM账户加入到多个EIAM组织中,如果该账户已在该组织中,则直接返回成功。
DeleteUser删除一个EIAM账户删除一个指定的EIAM账户,会清除账户相关的所有信息。
RemoveUserFromOrganizationalUnits将一个EIAM账户从多个EIAM组织中移除将指定EIAM账户从多个EIAM组织中移除,若该组织为EIAM的主组织,则不支持移除操作。
UpdateUser更新一个EIAM账户基本信息更新一个EIAM账户基本信息。
UpdateUserPassword更新一个EIAM账户密码更新一个指定EIAM账户的密码,密码需符合控制台密码策略的规则要求。
UpdateUserDescription更新一个EIAM账户描述信息更新账户标签或描述。
DisableUser禁用一个EIAM账号将账号状态设置为禁用状态,若账户已处于禁用状态,则直接返回成功。
EnableUser启用一个EIAM账号将账号设置为启用状态。
UnlockUser解锁一个EIAM账户将处于锁定的EIAM账户进行解锁操作。
SetUserPrimaryOrganizationalUnit设置指定EIAM账户的主组织设置指定EIAM账户的主组织,账户将从旧主组织移除,加入到新主组织中。
GetUser查询一个EIAM账户信息查询一个EIAM账户详情信息。
ListUsers列表查询EIAM账户信息分页查询EIAM账户信息。

组织管理

API标题API概述
CreateOrganizationalUnit创建一个EIAM组织在指定组织下创建一个新的EIAM组织。
DeleteOrganizationalUnit删除一个EIAM组织删除一个指定的EIAM组织,若该组织下含有EIAM账户或子组织,则会删除失败。
UpdateOrganizationalUnit更新一个EIAM组织基本信息更新一个EIAM组织基本信息,如果参数不传,则默认不更新。
UpdateOrganizationalUnitDescription更新一个EIAM组织描述信息更新一个EIAM组织描述信息,来标记或备注打标。
UpdateOrganizationalUnitParentId更新一个EIAM组织的父组织ID更新一个EIAM组织的父组织ID,相当于将指定的EIAM组织从一个父节点移动到新节点下。
GetRootOrganizationalUnit查询EIAM根组织信息查询EIAM根组织信息。
GetOrganizationalUnit查询一个EIAM组织信息查询一个EIAM组织信息。
ListOrganizationalUnits列表查询EIAM组织信息分页查询EIAM组织信息。
ListOrganizationalUnitParents列表查询一个EIAM组织的所有先代组织列表查询指定EIAM组织的所有先代组织信息,结果的组织列表以顶级到底级的层级顺序排列。

账户组管理

API标题API概述
CreateGroup创建一个EIAM账户组创建一个EIAM账户组。
AddUsersToGroup将多个EIAM账户添加到指定EIAM账户组将多个EIAM账户添加到指定EIAM账户组。
DeleteGroup删除一个EIAM账户组删除一个EIAM账户组信息。
RemoveUsersFromGroup将多个EIAM账户从指定EIAM账户组中移除将多个EIAM账户从指定EIAM账户组中移除。
UpdateGroup更新一个EIAM账户组更新一个EIAM账户组信息,如果信息为空,则默认不更新。
UpdateGroupDescription更新一个EIAM账户组描述更新一个EIAM账户组描述信息,可作为备注或标记。
GetGroup查询一个EIAM账户组查询一个EIAM账户组详情信息。
ListGroups列表查询EIAM账户组信息列表查询EIAM账户组列表信息。
ListUsersForGroup列表查询一个EIAM账户组下的账户信息查询指定EIAM账户组下的账户列表。
ListGroupsForUser列表查询一个EIAM账户的所属账户组信息查询指定EIAM账户的所属账户组列表。

密码策略

API标题API概述
SetForgetPasswordConfiguration设置EIAM忘记密码策略设置EIAM忘记密码策略。
SetPasswordInitializationConfiguration设置EIAM密码初始化策略设置指定EIAM实例下密码初始化策略。
SetPasswordHistoryConfiguration设置EIAM密码历史策略设置指定EIAM实例下的密码历史策略。
SetPasswordExpirationConfiguration设置EIAM密码过期策略设置指定EIAM实例下密码过期策略。
SetPasswordComplexityConfiguration设置EIAM密码复杂度策略设置指定EIAM实例下密码复杂度策略。
GetForgetPasswordConfiguration查询EIAM忘记密码策略查询指定EIAM实例下忘记密码策略。
GetPasswordInitializationConfiguration查询EIAM密码初始化策略查询EIAM密码初始化策略。
GetPasswordHistoryConfiguration查询EIAM密码历史策略查询指定EIAM实例下的密码历史策略。
GetPasswordExpirationConfiguration查询EIAM密码过期策略查询指定EIAM实例下密码过期策略。
GetPasswordComplexityConfiguration查询EIAM密码复杂度策略查询指定EIAM实例下密码复杂度策略。

网络端点

API标题API概述
CreateNetworkAccessEndpoint创建一个网络端点创建一个专属网络端点。
DeleteNetworkAccessEndpoint删除一个专属网络端点删除一个专属类型的网络端点。
UpdateNetworkAccessEndpointName更新网络端点名称修改一个专属类型的网络端点名称。
ListNetworkAccessEndpointAvailableRegions查询网络端点支持地域列表查询IDaaS EIAM支持创建网络端点的地域列表。
ListNetworkAccessEndpointAvailableZones查询网络端点支持的可用区列表查询IDaaS EIAM指定地域支持创建网络端点的可用区列表。
GetNetworkAccessEndpoint查询一个网络端点信息查询指定的网络端点信息。
ListNetworkAccessEndpoints查询网络端点列表查询IDaaS EIAM实例下的网络端点列表。
ListNetworkAccessPaths查询网络端点的访问路径列表查询指定网络端点下的访问路径列表。
  • 本页导读 (0)
文档反馈