API概览

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

在使用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实例由初始化域名自动跳转到默认域名,关闭后,通过初始化域名访问门户业不会跳转到默认域名。
GetInstanceLicense 查询实例的License信息 查询实例当前生效的 License 信息。

域名管理

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才能被删除。
UpdateDomainIcpNumber 更新域名备案号。 更新域名备案号。

应用管理

API

标题

API概述

应用基本信息管理 应用基本信息管理
CreateApplication 创建一个EIAM应用 在指定EIAM实例下创建一个应用资源。
DeleteApplication 删除一个EIAM应用 删除一个EIAM应用资源。
UpdateApplicationDescription 更新一个EIAM应用的描述信息 更新一个EIAM应用的描述信息。
EnableApplication 启用一个EIAM应用 将一个应用从禁用状态变为启用状态。
DisableApplication 禁用一个EIAM应用 将一个应用从启用状态变为禁用状态,此时应用全部能力不可用。
GetApplication 查询一个EIAM应用的详细信息 获取指定EIAM应用的详细信息。
ListApplications 列表查询EIAM应用 分页查询一个或者多个EIAM应用信息。
GetApplicationTemplate 获取应用模板信息。 获取应用模板信息
UpdateApplicationInfo 更新应用基本信息。 更新应用基本信息
ListApplicationsForNetworkAccessEndpoint 获取网络访问端点下的App信息。 获取网络访问端点下的App信息。
ListApplicationsForNetworkZone 获取网络域关联的应用列表。 获取网络域关联的应用列表。
ListApplicationsForGroup 查询一个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接口。
UpdateApplicationClientSecretExpirationTime 更新一个EIAM应用的客户端密钥有效期 更新应用的指定ClientSecret的到期时间。
应用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账户或子组织,则会删除失败。
DeleteOrganizationalUnitChildren 删除组织及下面的所有账户和子组织 删除指定组织的所有数据,可以强制删除指定组织下所有账户和子组织。
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概述

CreateIdentityProvider 创建身份提供方 创建身份提供方。
DeleteIdentityProvider 删除身份提供方 删除身份提供方。
UpdateIdentityProvider 更新身份提供方基础配置 更新身份提供方基础配置信息。
GetIdentityProvider 获取身份提供方 获取身份提供方。
ListIdentityProviders 获取身份提供方列表 查询身份提供方列表。
EnableIdentityProviderUdPull 启用身份提供方同步入 启用身份提供方同步入功能。
DisableIdentityProviderUdPull 禁用身份提供方同步入 禁用身份提供方同步入功能。
SetIdentityProviderUdPullConfiguration 设置IdP同步入配置信息 修改IdP同步入方向配置信息。
GetIdentityProviderUdPullConfiguration 获取IdP同步入配置信息 获取IdP同步入配置信息。
ListIdentityProvidersForNetworkAccessEndpoint 获取网络端点下的IdP信息。 获取网络端点下的IdP信息。

密码策略

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概述

CreateConditionalAccessPolicy 创建条件访问策略 创建条件访问策略。
DeleteConditionalAccessPolicy 删除条件访问策略 删除条件访问策略。
DisableConditionalAccessPolicy 禁用条件访问策略 禁用条件访问策略。
EnableConditionalAccessPolicy 启用条件访问策略 启用条件访问策略。
GetConditionalAccessPolicy 查询条件访问策略 获取条件访问策略。
ListConditionalAccessPolicies 条件访问策略列表 条件访问策略列表。
ListConditionalAccessPoliciesForNetworkZone 获取网络范围关联的条件访问策略列表 获取网络范围关联的条件访问策略列表。
UpdateConditionalAccessPolicy 更新条件访问策略 更新条件访问策略。
UpdateConditionalAccessPolicyDescription 更新条件访问策略描述 更新条件访问策略描述。
ListConditionalAccessPoliciesForUser 获取用户关联的条件访问策略列表。 获取用户关联的条件访问策略列表。
ListConditionalAccessPoliciesForApplication 获取应用关联的条件访问策略列表。 获取应用关联的条件访问策略列表。

同步

API

标题

API概述

ListSynchronizationJobs 列表查询同步任务信息 列表查询同步任务详情信息。
RunSynchronizationJob 运行同步任务 运行一个同步任务,会创建一个新的同步任务并立刻执行该任务。
GetSynchronizationJob 查询单个同步任务信息 获取单个同步任务详情信息。

网络端点

API

标题

API概述

CreateNetworkAccessEndpoint 创建一个网络端点 创建一个专属网络端点。
DeleteNetworkAccessEndpoint 删除一个专属网络端点 删除一个专属类型的网络端点。
UpdateNetworkAccessEndpointName 更新网络端点名称 修改一个专属类型的网络端点名称。
ListNetworkAccessEndpointAvailableRegions 查询网络端点支持地域列表 查询IDaaS EIAM支持创建网络端点的地域列表。
ListNetworkAccessEndpointAvailableZones 查询网络端点支持的可用区列表 查询IDaaS EIAM指定地域支持创建网络端点的可用区列表。
GetNetworkAccessEndpoint 查询一个网络端点信息 查询指定的网络端点信息。
ListNetworkAccessEndpoints 查询网络端点列表 查询IDaaS EIAM实例下的网络端点列表。
ListNetworkAccessPaths 查询网络端点的访问路径列表 查询指定网络端点下的访问路径列表。

网络区域

API

标题

API概述

CreateNetworkZone 创建网络区域对象。 创建网络区域对象。
DeleteNetworkZone 删除网络区域对象。 删除网络区域对象。
UpdateNetworkZone 更新网络区域对象。 更新网络区域对象。
UpdateNetworkZoneDescription 更新网络区域对象描述。 更新网络区域对象描述。
ListNetworkZones 查询网络区域对象列表。 查询网络区域对象列表。
GetNetworkZone 获取网络区域对象。 获取网络区域对象。

其他

API

标题

API概述

ListEiamRegions 查询EIAM2.0/EIAM1.0地域列表 查询EIAM2.0/EIAM1.0地域列表。
ListEiamInstances 获取IDaaS实例列表 查询EIAM2.0/EIAM1.0实例列表。