查询实例配置信息
功能介绍
查询IAM身份中心实例配置信息，包括身份认证配置和会话管理配置信息。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/instances/{instance_id}/sso-configuration
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
instance_id |
是 |
String |
IAM Identity Center实例的全局唯一标识符（ID） |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
sso_configuration |
SSOConfigurationDto object |
IAM Identity Center 实例配置信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
mfa_mode |
String |
MFA生效模式 |
|
no_mfa_signin_behavior |
String |
未注册MFA情况下，可选择的登录行为 |
|
no_password_signin_behavior |
String |
没有密码情况下登录的行为 |
|
allowed_mfa_types |
Array of strings |
允许的MFA类型 |
|
session_configuration |
SessionConfigurationDto object |
会话生效配置 |
状态码：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}/sso-configuration
响应示例
状态码：200
Successful
{
"sso_configuration" : {
"mfa_mode" : "ALWAYS_ON",
"no_mfa_signin_behavior" : "ALLOWED",
"no_password_signin_behavior" : "BLOCKED",
"allowed_mfa_types" : [ "TOTP" ],
"session_configuration" : {
"max_authentication_age" : "PT8H"
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Successful |
|
400 |
Bad request |
|
403 |
Forbidden |
|
404 |
Forbidden |
错误码
请参见错误码。
