文档

GetExternalSAMLIdentityProvider - 查询SAML身份提供商配置信息

更新时间:
一键部署

调用GetExternalSAMLIdentityProvider查询SAML身份提供商(IdP)的配置信息。

接口说明

本文将提供一个示例,查询目录d-00fc2p61****下的 SAML 身份提供商的配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cloudsso:GetExternalSAMLIdentityProviderRead
  • Directory
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

请求参数

名称类型必填描述示例值
DirectoryIdstring

目录 ID。

d-00fc2p61****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

96D1E5FF-0301-5636-8D33-071E033CFB82
SAMLIdentityProviderConfigurationobject

IdP 配置信息。

EntityIdstring

IdP 标识。

http://www.okta.com/exk3qwgtjhetR2Od****
SSOStatusstring

SSO 登录的启用状态。取值:

  • Enabled:启用。
  • Disabled:禁用。
Enabled
DirectoryIdstring

目录 ID。

d-00fc2p61****
EncodedMetadataDocumentstring

IdP 元数据文档(Base64 编码)。

PD94bWwgdmVyc2lvbj0iMS4****
CreateTimestring

首次配置 IdP 的时间。

2021-11-09T09:30:13Z
WantRequestSignedboolean

在用户访问云 SSO 登录页面发起 SAML SSO 时,是否要求云 SSO 发送签名的 SAML 请求。取值:

  • true:要求签名。
  • false(默认值):不要求签名。
false
UpdateTimestring

最近一次修改 IdP 配置的时间。

2021-11-09T09:30:22Z
CertificateIdsarray

SAML 签名证书列表。

string

SAML 签名证书 ID。

多个 ID 之间用半角逗号(,)分隔。

[ "idp-c-00s6c04my7hvv1uj****" ]
LoginUrlstring

IdP 的登录地址。

https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml

示例

正常返回示例

JSON格式

{
  "RequestId": "96D1E5FF-0301-5636-8D33-071E033CFB82",
  "SAMLIdentityProviderConfiguration": {
    "EntityId": "http://www.okta.com/exk3qwgtjhetR2Od****",
    "SSOStatus": "Enabled",
    "DirectoryId": "d-00fc2p61****",
    "EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4****",
    "CreateTime": "2021-11-09T09:30:13Z",
    "WantRequestSigned": false,
    "UpdateTime": "2021-11-09T09:30:22Z",
    "CertificateIds": [
      "[ \"idp-c-00s6c04my7hvv1uj****\" ]"
    ],
    "LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml"
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)