API标准及多语言预置SDK
本产品（Eiam/2021-12-01）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
地域
|
API |
标题 |
API概述 |
| ListRegions | 查询EIAM支持的地域列表 | 查询支持的阿里云地域列表。 |
实例管理
|
API |
标题 |
API概述 |
| GetServiceQuota | 获取服务Quota | 获取服务Quota |
| RenewFreeLicenseEndTime | 免费版续期 | 免费版续期 |
| SetInstanceControlConfiguration | 设置实例控制项 | 设置实例控制项 |
| SetInstanceGlobalizationConfig | 设置实例语言、时区信息 | 设置实例语言、时区信息 |
| CreateInstanceTrialLicense | 创建试用版 License | 为实例创建试用版 License |
| CheckInstanceModuleStatus | 判断实例是否具有某个模块的功能 | 判断实例是否具有某个模块的功能 |
| CheckInstanceForDelete | 实例删除检查 | 实例删除检查 |
| GetInstanceGlobalizationConfig | 获取实例语言、时区信息 | 获取实例语言、时区信息 |
| GetInstanceControlConfiguration | 查询实例控制项 | 查询实例控制项 |
| GetInstanceModuleInfo | 获取一级模块下，所有模块信息 | 获取一级模块下，所有模块信息 |
| GetInstanceQuota | 获取实例单一类型的Quota | 获取实例单一类型的Quota |
| GetInstanceTrialStatus | 获取实例的试用状态 | 获取实例的试用状态 |
| 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 | 更新域名备案号 | 更新域名备案号。 |
| UpdateDomainBrand | 修改域名品牌 | 修改域名关联的品牌。 |
应用管理
|
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配置属性。 |
| UpdateApplicationSsoFormParams | 更新模板应用的SSO参数 | 更新模板应用的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接口。 |
| 应用联邦凭证管理 | 应用联邦凭证管理 | |
| UpdateApplicationFederatedCredentialDescription | 更新应用联邦凭证描述 | 更新应用联邦凭证描述。 |
| UpdateApplicationFederatedCredential | 更新应用联邦凭证 | 更新应用联邦凭证。 |
| ListApplicationFederatedCredentials | 查询应用联邦凭证列表 | 查询应用联邦凭证列表。 |
| GetApplicationFederatedCredential | 获取应用联邦凭证 | 获取应用联邦凭证。 |
| EnableApplicationFederatedCredential | 启用应用联邦凭证 | 启用应用联邦凭证。 |
| DisableApplicationFederatedCredential | 禁用应用联邦凭证 | 禁用应用联邦凭证。 |
| DeleteApplicationFederatedCredential | 删除应用联邦凭证 | 删除应用联邦凭证。 |
| CreateApplicationFederatedCredential | 创建应用联邦凭证 | 创建应用联邦凭证。 |
| 应用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的到期时间。 |
| 应用Token管理 | 应用Token管理 | |
| UpdateApplicationTokenExpirationTime | 更新应用Token过期时间 | 更新ApplicationToken过期时间。 |
| EnableApplicationToken | 启用应用Token | 启用应用Token。 |
| DisableApplicationToken | 禁用应用Token | 禁用应用Token。 |
| CreateApplicationToken | 创建应用Token | 创建应用Token。 |
| ListApplicationTokens | 获取应用Token列表 | 获取应用Token列表。 |
| ObtainApplicationToken | 查询指定应用Token | 查询指定应用Token。 |
| DeleteApplicationToken | 删除应用Token | 删除ApplicationToken。 |
| 应用子账号管理 | 应用子账号管理 | |
| AddApplicationAccountToUser | 在当前应用下给指定员工添加一个应用账号 | 在当前应用下给指定员工添加一个应用账号。 |
| ListApplicationAccounts | 分页查询应用下的应用账户列表 | 分页查询应用下的应用账户列表。 |
| ListApplicationAccountsForUser | 查询当前应用下指定用户的所有账号 | 查询当前应用下指定用户的所有账号。 |
| RemoveApplicationAccountFromUser | 删除一个当前应用下的指定员工的应用账号 | 删除一个当前应用下的指定员工的应用账号。 |
| 应用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授权范围。 |
| 应用账户同步 | 应用账户同步 | |
| GetApplicationProvisioningUserPrimaryOrganizationalUnit | 查询指定应用同步配置 | 查询指定应用同步配置 |
| CheckApplicationProvisioningUserPrimaryOrganizationalUnit | 检查应用同步主组织是否在应用同步范围 | 检查应用同步主组织是否在应用同步范围 |
| SetApplicationProvisioningUserPrimaryOrganizationalUnit | 配置应用同步用户主组织 | 配置应用同步用户主组织 |
| DisableApplicationProvisioning | 禁用一个EIAM应用的账户同步功能 | 禁用一个EIAM应用的账户同步功能。 |
| EnableApplicationProvisioning | 启用一个EIAM应用的账户同步功能 | 启用一个EIAM应用的账户同步功能。 |
| SetApplicationProvisioningConfig | 设置一个EIAM应用的账户同步功能配置 | 设置一个EIAM应用的账户同步功能配置。 |
| SetApplicationProvisioningScope | 设置一个EIAM应用的账户同步范围 | 设置一个EIAM应用的账户同步范围，该账户同步范围同时为DeveloperAPI可以查询和管理的账户范围。 |
| GetApplicationProvisioningConfig | 查询一个EIAM应用的账户同步功能配置 | 查询一个EIAM应用的账户同步功能配置。 |
| GetApplicationProvisioningScope | 查询一个EIAM应用的账户同步范围 | 查询EIAM应用的账户同步范围，该账户同步范围同时为DeveloperAPI可以查询和管理的账户范围。 |
| 应用高阶配置 | 应用高阶配置 | |
| UpdateApplicationAdvancedConfig | 修改应用高阶配置 | 修改应用高阶配置 |
| GetApplicationAdvancedConfig | 获取应用高阶配置 | 获取应用高阶配置 |
| 应用角色管理 | 应用角色管理 | |
| CreateApplicationRole | 创建应用角色 | 创建应用角色。 |
| DeleteApplicationRole | 删除应用角色 | 删除应用角色。 |
| UpdateApplicationRole | 修改应用角色 | 修改应用角色。 |
| UpdateApplicationRoleDescription | 修改应用角色描述 | 修改应用角色描述。 |
| GetApplicationRole | 获取应用角色信息 | 获取应用角色信息。 |
| ListApplicationRoles | 查询应用角色列表 | 游标方式查询应用角色列表。 |
M2M管理
|
API |
标题 |
API概述 |
| 基础能力管理 | 基础能力管理 | |
| EnableApplicationResourceServer | 启用指定应用的ResourceServer能力 | 启用指定应用的ResourceServer能力。 |
| DisableApplicationResourceServer | 禁用指定应用的ResourceServer能力 | 禁用指定应用的ResourceServer能力。 |
| EnableApplicationM2MClient | 启用应用的M2M客户端能力 | 启用应用的M2M客户端能力（开启该功能后，应用可以作为调用方（即OAuth中的客户端）发起对资源的访问）。 |
| DisableApplicationM2MClient | 禁用应用M2M客户端能力 | 禁用应用M2M客户端能力（开启该功能后，应用可以作为调用方（即OAuth中的客户端）发起对资源的访问）。 |
| EnableResourceServerCustomSubject | 启用指定ResourceServer的自定义Subject能力 |
启用指定ResourceServer的自定义Subject能力（开启自定义主体后，签发的 Access Token 将从(clientld) 变成 |
| DisableResourceServerCustomSubject | 禁用指定ResourceServer的自定义Subject能力 | 禁用指定ResourceServer的自定义Subject能力。 |
| SetApplicationResourceServerIdentifier | 设置ResourceServer的Identifier唯一标识 | 设置ResourceServer的Identifier唯一标识（该字段含义表示在使用JWT协议中Payload对应的Claims的aud (audience)字段参数值，即JWT的接收对象或服务）。 |
| 授权管理 | 授权管理 | |
| 权限管理 | 权限管理 | |
| CreateResourceServerScope | 创建指定ResourceServer下的Scope权限 | 创建指定ResourceServer下的Scope权限。 |
| UpdateResourceServerScope | 修改指定ResourceServer下的Scope权限 | 修改指定ResourceServer下的Scope权限。 |
| DeleteResourceServerScope | 删除指定ResourceServer下的Scope权限 | 删除指定ResourceServer下的Scope权限。 |
| GetResourceServerScope | 查询指定ResourceServer下的Scope权限 | 查询指定ResourceServer下的Scope权限。 |
| ListResourceServerScopes | 查询指定ResourceServer下的Scope权限列表 | 游标方式查询指定ResourceServer下的Scope权限列表。 |
| 机器授权管理 | 机器授权管理 | |
| AuthorizeResourceServerToClient | 授权指定ResourceServer给Client应用 | 授权指定ResourceServer给Client应用。 |
| RevokeResourceServerFromClient | 取消指定ResourceServer给Client应用的授权 | 取消指定ResourceServer给Client应用的授权。 |
| AuthorizeResourceServerScopesToClient | 授权指定ResourceServer下的Scope权限给Client应用 | 授权指定ResourceServer下的Scope权限给Client应用。 |
| RevokeResourceServerScopesFromClient | 取消指定ResourceServer下的Scope权限给Client应用的授权 | 取消指定ResourceServer下的Scope权限给Client应用的授权。 |
| 人员授权管理 | 人员授权管理 | |
| AuthorizeResourceServerScopesToUser | 授权指定ResourceServer下的Scope权限给账户 | 授权指定ResourceServer下的Scope权限给账户。 |
| RevokeResourceServerScopesFromUser | 取消指定ResourceServer下的Scope权限给账户的授权 | 取消指定ResourceServer下的Scope权限给账户的授权。 |
| AuthorizeResourceServerScopesToOrganizationalUnit | 授权指定ResourceServer下的Scope权限给组织 | 授权指定ResourceServer下的Scope权限给组织。 |
| RevokeResourceServerScopesFromOrganizationalUnit | 取消指定ResourceServer下的Scope权限给组织的授权 | 取消指定ResourceServer下的Scope权限给组织的授权。 |
| AuthorizeResourceServerScopesToGroup | 授权指定ResourceServer下的Scope权限给组 | 授权指定ResourceServer下的Scope权限给组。 |
| RevokeResourceServerScopesFromGroup | 取消指定ResourceServer下的Scope权限给组的授权 | 取消指定ResourceServer下的Scope权限给组的授权。 |
| ListUsersForResourceServer | 查询当前ResourceServer授权到账户的Scope权限列表 | 游标方式查询当前ResourceServer授权到账户的Scope权限列表。 |
| ListResourceServersForUser | 查询当前账户被授予的ResourceServer和Scope权限列表 | 游标方式查询当前账户被授予的ResourceServer和Scope权限列表。 |
| ListOrganizationalUnitsForResourceServer | 查询当前ResourceServer授权到组织的Scope权限列表 | 游标方式查询当前ResourceServer授权到组织的Scope权限列表。 |
| ListGroupsForResourceServer | 查询当前ResourceServer授权到组的Scope权限列表 | 游标方式查询当前ResourceServer授权到组的Scope权限列表。 |
| 应用ClientPublicKey管理 | 应用ClientPublicKey管理 | |
| CreateClientPublicKey | 创建应用ClientPublicKey | 创建应用ClientPublicKey（当M2M客户端使用PRIVATE_KEY_JWT方式请求token端点时，该公钥用于M2M授权服务器校验客户端请求token端点时，携带的assertion断言。）。 |
| DeleteClientPublicKey | 删除指定的应用ClientPublicKey | 删除指定的应用ClientPublicKey。 |
| EnableClientPublicKey | 启用指定的应用ClientPublicKey | 启用指定的应用ClientPublicKey。 |
| DisableClientPublicKey | 禁用指定的应用ClientPublicKey | 禁用指定的应用ClientPublicKey。 |
| SetPrimaryClientPublicKey | 设置指定的应用ClientPublicKey优先使用 | 将指定的应用ClientPublicKey设置为优先使用。 |
| GetClientPublicKey | 查询指定应用ClientPublicKey | 查询指定应用ClientPublicKey。 |
| ListClientPublicKeys | 查询指定应用的ClientPublicKey列表 | 游标方式查询指定应用的ClientPublicKey列表。 |
联邦信任源管理
|
API |
标题 |
API概述 |
| DeleteFederatedCredentialProvider | 删除联邦信任源 | 删除联邦信任源。 |
| UpdateFederatedCredentialProviderDescription | 更新联邦信任源描述 | 更新联邦信任源描述。 |
| UpdateFederatedCredentialProvider | 更新联邦信任源 | 更新联邦信任源。 |
| ListFederatedCredentialProviders | 查询联邦信任源列表 | 查询联邦信任源列表。 |
| ListApplicationFederatedCredentialsForProvider | 根据联邦信任源ID查询应用联邦凭证列表 | 根据联邦信任源ID查询应用联邦凭证列表。 |
| GetFederatedCredentialProvider | 获取联邦信任源 | 获取联邦信任源。 |
| EnableFederatedCredentialProvider | 启用联邦信任源 | 启用联邦信任源。 |
| DisableFederatedCredentialProvider | 禁用联邦信任源 | 禁用联邦信任源。 |
| CreateFederatedCredentialProvider | 创建联邦信任源 | 创建联邦信任源。 |
账户管理
|
API |
标题 |
API概述 |
| DeleteUsers | 批量删除账户 | 批量删除账号 |
| 管理三方登录账户 | 管理三方登录账户 | |
| BindUserAuthnSourceMapping | 绑定三方登录账户 | 绑定三方登录账户 |
| UnbindUserAuthnSourceMapping | 解绑三方登录账户 | 解绑三方登录账户 |
| ListUserAuthnSourceMappings | 查询三方账户绑定列表 | 查询三方登录账户绑定关系 |
| 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概述 |
| 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概述 |
| CreateBrand | 创建品牌 | 创建品牌。 |
| GetBrand | 查询一个品牌的信息 | 获取品牌详情 |
| EnableBrand | 启用品牌 | 启用品牌 |
| DisableBrand | 禁用品牌 | 禁用品牌 |
| UpdateBrand | 更新品牌 | 修改品牌 |
| DeleteBrand | 删除品牌 | 删除品牌 |
| ListBrands | 查询品牌列表 | 获取品牌列表 |
| SetLoginRedirectApplicationForBrand | 为品牌设置登录跳转应用 | 为品牌设置登录后跳转应用 |
| GetLoginRedirectApplicationForBrand | 获取品牌登录跳转应用 | 为品牌设置登录后跳转应用 |
自定义条款
|
API |
标题 |
API概述 |
| CreateCustomPrivacyPolicy | 创建自定义条款 | 创建自定义条款 |
| GetCustomPrivacyPolicy | 获取自定义条款 | 获取自定义条款 |
| EnableCustomPrivacyPolicy | 启用自定义条款 | 启用自定义条款 |
| DisableCustomPrivacyPolicy | 禁用自定义条款 | 禁用自定义条款 |
| UpdateCustomPrivacyPolicy | 更新自定义条款信息 | 更新自定义条款 |
| DeleteCustomPrivacyPolicy | 删除自定义条款 | 删除自定义条款 |
| ListCustomPrivacyPolicies | 查询自定义条款列表 | 自定义条款列表查询。 |
| AddCustomPrivacyPoliciesToBrand | 添加自定义条款到品牌 | 添加条款到品牌 |
| RemoveCustomPrivacyPoliciesFromBrand | 从品牌移除自定义条款 | 移除品牌关联条款 |
| ListCustomPrivacyPoliciesForBrand | 查询品牌关联的自定义条款列表 | 获取品牌关联资源的资源 |
网络端点
|
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概述 |
| EnableInternalAuthenticationSource | 启用内部认证源 | 启用内部认证源 |
| DisableInternalAuthenticationSource | 禁用内部认证源 | 禁用内部认证源 |
认证器
|
API |
标题 |
API概述 |
| SetWebAuthnConfiguration | 设置WebAuthn配置 | 设置WebAuthn配置 |
| UnbindTotpAuthenticator | 解绑指定用户TOTP | 解绑指定用户TOTP |
| DeleteWebAuthnAuthenticator | 删除指定WebAuthn认证器名称 | 删除指定WebAuthn认证器名称 |
云账号
|
API |
标题 |
API概述 |
| ListCloudAccounts | 列表查询云账号 | 分页查询一个或者多个云账号信息。 |
| GetCloudAccount | 查询一个云账号信息 | 查询一个云账号资源信息。 |
| CreateCloudAccount | 创建一个云账号 | 在指定EIAM实例下创建一个云账号资源。 |
| UpdateCloudAccount | 更新一个云账号基本信息 | 更新一个云账号基本信息。 |
| UpdateCloudAccountDescription | 更新一个云账号的描述信息 | 更新一个云账号的描述信息。 |
| DeleteCloudAccount | 删除一个云账号 | 删除一个云账号资源。 |
云角色
|
API |
标题 |
API概述 |
| ListCloudAccountRoles | 列表查询云角色 | 分页查询一个或者多个云角色信息。 |
| GetCloudAccountRole | 查询一个云角色信息 | 查询一个云角色资源信息。 |
| CreateCloudAccountRole | 创建一个云角色 | 在指定云账号资源下创建一个云角色资源。 |
| DisableCloudAccountRole | 禁用一个云角色 | 在指定云账号资源下禁用一个云角色资源。 |
| EnableCloudAccountRole | 启用一个云角色 | 在指定云账号资源下启用一个云角色资源。 |
| UpdateCloudAccountRoleDescription | 更新一个云角色的描述信息 | 更新一个云角色的描述信息。 |
| DeleteCloudAccountRole | 删除一个云角色 | 在指定云账号资源下删除一个云角色资源。 |
凭据
|
API |
标题 |
API概述 |
| ListCredentials | 列表查询凭据 | 分页查询一个或者多个凭据信息。 |
| GetCredential | 查询一个凭据信息 | 查询一个凭据资源信息。 |
| ObtainCredential | 查询一个含敏感信息的凭据 | 查询一个含敏感信息的凭据资源。 |
| CreateCredential | 创建一个凭据 | 在指定EIAM实例下创建一个凭据资源。 |
| DisableCredential | 禁用一个凭据 | 禁用一个凭据资源。 |
| EnableCredential | 启用一个凭据 | 启用一个凭据资源。 |
| UpdateCredential | 更新一个凭据基本信息 | 更新一个凭据基本信息。 |
| UpdateCredentialDescription | 更新一个凭据的描述信息 | 更新一个凭据的描述信息。 |
| DeleteCredential | 删除一个凭据 | 删除一个凭据资源。 |
凭据提供商
|
API |
标题 |
API概述 |
| CreateCredentialProvider | 创建凭据提供商 | 创建凭据提供商 |
| DeleteCredentialProvider | 删除凭据提供商 | 删除凭据提供商 |
| DisableCredentialProvider | 禁用凭据提供商 | 禁用凭据提供商 |
| EnableCredentialProvider | 启用凭据提供商 | 启用凭据提供商 |
| GetCredentialProvider | 查询凭据提供商详情 | 查询凭据提供商详情 |
| ListCredentialProviders | 列举凭据提供商 | 列举凭据提供商 |
| UpdateCredentialProvider | 更新凭据提供商 | 更新凭据提供商 |
| UpdateCredentialProviderDescription | 更新凭据提供商描述 | 更新凭据提供商描述 |
数据权限管理
导入文件
|
API |
标题 |
API概述 |
| GenerateUploadAuth | 获取上传认证 | 获取上传认证 |
| GenerateFileImportTemplate | 生成文件导入模板 | 生成文件导入模板 |
| GenerateDownloadUrlForSynchronizationJob | 生成文件导入结果下载地址 | 生成文件导入结果下载地址 |
OAuth Token
|
API |
标题 |
API概述 |
| GenerateOauthToken | 生成 OAuth Token | 以指定应用作为客户端身份获取访问资源服务器的 Access Token。 |
扩展属性
|
API |
标题 |
API概述 |
| GetCustomField | 获取扩展字段信息 | 获取扩展字段信息 |
| EnableCustomField | 启用字段 | 启用字段 |
| DisableCustomField | 禁用字段 | 禁用字段 |
| DeleteCustomField | 删除扩展字段 | 删除扩展字段 |
| CreateCustomField | 创建扩展字段 | 创建扩展字段 |
事件
|
API |
标题 |
API概述 |
| ListEventTypes | 查看事件列表 | 查看事件列表 |
| ListActionTrackEventTypes | 查看调用事件列表 | 查看调用事件列表 |
其它
|
API |
标题 |
API概述 |
| ListEiamInstances | 获取IDaaS实例列表 | 查询EIAM2.0/EIAM1.0实例列表。 |
| ListEiamRegions | 查询EIAM2.0/EIAM1.0地域列表 | 查询EIAM2.0/EIAM1.0地域列表。 |
| ListApplicationSupportedProvisionProtocolTypes | 列表查询应用支持的账户同步类型 | 调用 ListApplicationSupportedProvisionProtocolTypes 接口查询应用支持的账户同步类型列表。 |
| GenerateWebAuthnAuthenticatorRegistrationUrl | 生成WebAuthn认证器注册URL | 生成WebAuthn认证器注册URL |
| GetAuthorizationServer | 获取授权服务器信息 | 查询授权服务器 |
| UpdateAuthorizationServerDescription | 更新授权服务器描述 | 更新授权服务器的描述信息 |
| ListAuthorizationServers | 查询授权服务器列表 | 获取实例下所有授权服务器列表 |
| UpdateAuthorizationServer | 更新授权服务器 | 更新授权服务器配置 |
该文章对您有帮助吗？