获取身份源配置
功能介绍
获取IAM身份中心服务实例中的身份源配置信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/instances/{instance_id}/identity-store-associations
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_id |
是 |
String |
IAM Identity Center实例的全局唯一标识符(ID) |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
identity_store_associations |
Array of IdentityStoreDto objects |
IAM身份中心服务实例关联的身份源配置信息 |
参数 |
参数类型 |
描述 |
---|---|---|
identity_store_id |
String |
关联到IAM身份中心实例的身份源的全局唯一标识符(ID)。 |
identity_store_type |
String |
身份源类型 |
authentication_type |
String |
登录认证类型 |
provisioning_type |
Array of strings |
预配类型 |
status |
String |
身份源是否启用状态 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
request_id |
String |
请求唯一标识 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
request_id |
String |
请求唯一标识 |
encoded_authorization_message |
String |
加密的错误信息 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
request_id |
String |
请求唯一标识 |
请求示例
获取IAM身份中心服务实例中的身份源配置相关信息
GET https://{hostname}/v1/instances/{instance_id}/identity-store-associations
响应示例
状态码:200
Successful
{ "identity_store_associations" : [ { "identity_store_id" : "d-xxxxx", "identity_store_type" : "UserPool", "authentication_type" : "SAML_2.0", "provisioning_type" : [ "DEFAULT" ], "status" : "ENABLED" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
Successful |
400 |
Bad request |
403 |
Forbidden |
404 |
Not found |
错误码
请参见错误码。