文档

GetDirectorySAMLServiceProviderInfo - 查询SAML服务提供商信息

更新时间:
一键部署

调用GetDirectorySAMLServiceProviderInfo查询SAML服务提供商(SP)信息。

接口说明

在基于 SAML 2.0 的 SSO 登录过程中,云 SSO 目录是服务提供商(SP),而企业自有的身份管理系统则是身份提供商(IdP)。

本文将提供一个示例,查询目录d-00fc2p61****下的 SP 信息。

调试

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

授权信息

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

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

请求参数

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

目录 ID。

d-00fc2p61****

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

4632107D-BCE1-5A96-B30B-182EE0709625
SAMLServiceProviderobject

SP 信息。

EntityIdstring

SP 标识。

https://signin-cn-shanghai.alibabacloudsso.com/saml/sp/d-00fc2p61****
DirectoryIdstring

目录 ID。

d-00fc2p61****
EncodedMetadataDocumentstring

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

PD94bWwgdmVyc2lv****
AcsUrlstring

SP 的 ACS URL。

https://signin-cn-shanghai.alibabacloudsso.com/saml/acs/51d298a9-2a3f-4e23-97c7-7ad1cfa9****

示例

正常返回示例

JSON格式

{
  "RequestId": "4632107D-BCE1-5A96-B30B-182EE0709625",
  "SAMLServiceProvider": {
    "EntityId": "https://signin-cn-shanghai.alibabacloudsso.com/saml/sp/d-00fc2p61****",
    "DirectoryId": "d-00fc2p61****",
    "EncodedMetadataDocument": "PD94bWwgdmVyc2lv****",
    "AcsUrl": "https://signin-cn-shanghai.alibabacloudsso.com/saml/acs/51d298a9-2a3f-4e23-97c7-7ad1cfa9****",
    "AuthnSignAlgo": "",
    "CertificateType": "",
    "SupportEncryptedAssertion": true
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)