API概览

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

OIDC API

API标题API概述
GenerateToken生成应用认证token调用GenerateToken接口,生成指定实例下的访问应用的access token。
GenerateDeviceCode生成设备Code调用GenerateDeviceCode接口,生成设备流code。
GetUserInfo获取账户信息调用GetUserInfo接口,通过用户token获取账户信息。
RevokeToken吊销指定的token调用RevokeToken接口,吊销指定的access_token或refresh_token。

授权范围 API

API标题API概述
GetApplicationProvisioningScope获取应用同步范围信息调用GetApplicationProvisioningScope接口,获取指定实例下对应应用的同步范围信息。

组织管理 API

API标题API概述
CreateOrganizationalUnit创建一个EIAM组织调用CreateOrganizationalUnit接口,在指定组织下创建新组织资源。
PatchOrganizationalUnit更新一个EIAM组织调用PatchOrganizationalUnit接口,更新一个EIAM组织信息。
GetOrganizationalUnit查询一个EIAM组织信息调用GetOrganizationalUnit接口,获取指定组织的详细信息。
DeleteOrganizationalUnit删除一个EIAM组织调用DeleteOrganizationalUnit接口,删除指定组织。
ListOrganizationalUnits列表查询EIAM组织列表信息调用ListOrganizationalUnits接口,分页查询EIAM组织信息。
ListOrganizationalUnitParentIds列表查询组织先代节点调用ListOrganizationalUnitParentIds接口,查询指定组织所有先代节点信息。
GetOrganizationalUnitIdByExternalId通过组织外部ID获取组织ID调用GetOrganizationalUnitIdByExternalId接口,通过组织外部ID获取组织内部ID。

账户管理 API

API标题API概述
CreateUser创建一个EIAM账户调用CreateUser接口在指定组织下,创建新的EIAM的账户资源。
PatchUser更新一个EIAM账户信息调用PatchUser接口,更新一个EIAM账户信息。
GetUser查询一个EIAM账户详细信息调用GetUser接口,查询一个EIAM账户详细信息。
UpdateUserPassword更新一个EIAM账户的密码更新指定EIAM账户的密码信息。
DeleteUser删除一个EIAM账户调用DeleteUser接口,删除一个EIAM账户信息。
ListUsers列表查询EIAM账户调用ListUsers接口,分页查询EIAM账户信息。
EnableUser启用一个EIAM账户。调用EnableUser接口,启用指定的EIAM账户。
DisableUser禁用一个EIAM账户。调用DisableUser接口,禁用指定的EIAM账户。
GetUserIdByEmail通过邮箱获取EIAM账户ID。调用GetUserIdByEmail接口,通过邮箱获取EIAM对应账户ID。
GetUserIdByPhoneNumber通过手机号获取EIAM账户ID。调用GetUserIdByPhoneNumber接口,通过手机号获取EIAM对应账户ID。
GetUserIdByUserExternalId通过账户外部ID获取EIAM账户ID。调用GetUserIdByUserExternalId接口,通过账户外部ID获取EIAM账户ID。
GetUserIdByUsername通过账户名获取EIAM账户ID。调用GetUserIdByUsername接口,通过账户名获取EIAM对应账户ID。
SetUserPrimaryOrganizationalUnit设置一个EIAM账户所属主组织设置一个EIAM账户的所属主组织,账户会从旧主组织移除,并加入到新的组织下。
AddUserToOrganizationalUnits将一个EIAM账户加入到多个EIAM组织中将一个EIAM账户加入到多个EIAM组织中,这些组织作为账户的从属组织,如果账户已属于相关组织,则不做更新。
RemoveUserFromOrganizationalUnits将一个EIAM账户从多个EIAM组织中移除将一个EIAM账户从多个EIAM组织中移除,如果账户已不属于这些组织,则默认成功。
阿里云首页 应用身份服务 相关技术圈