You need to enable JavaScript to run this app.
导航
访问控制
  • 文档首页
    • /
  • 访问控制

GetSAMLProvider - 查询 SAML 身份提供商

最近更新时间：2024.02.23 13:58:53

首次发布时间：2024.02.23 13:58:53

我的收藏

查询 SAML 身份提供商

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

GetSAMLProvider

要执行的操作，取值：GetSAMLProvider

Version
String
是

2018-01-01

API的版本，取值：2018-01-01

SAMLProviderName
String
是

身份提供商名称

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Trn
String

trn:iam::2100000000:saml-provider/my-provider

身份提供商 Trn

ProviderName
String

身份提供商名称

SSOType
Integer

身份提供商 SSO 类型

  1. 角色 SSO
  2. 用户 SSO
EncodedSAMLMetadataDocument
String

SAML 身份提供商元数据文件 Base64 编码

Status
Integer

身份提供商状态 (仅用户 SSO)

  1. 开启
  2. 开启并禁用其他登录方式
  3. 关闭
Description
String

身份提供商描述

CreateDate
String

2024-01-03T16:10:57+08:00

创建时间

UpdateDate
String

2024-01-03T16:10:57+08:00

更新时间

CertificateExpireTime
String

2024-09-17T16:12:15+08:00

SAML 证书过期提醒时间

请求示例

GET '/?Action=GetSAMLProvider&Version=2018-01-01&SAMLProviderName=test'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202205191150550102252431470183A0D5",
        "Action": "GetSAMLProvider",
        "Version": "2018-01-01"
    },
    "Result": {
        "Trn": "trn:iam::2100000000:saml-provider/test",
        "EncodedSAMLMetadataDocument": "PD94bWwgdm...",
        "SSOType": 1,
        "Status": 1,
        "ProviderName": "test",
        "Description": "test",
        "CreateDate": "2023-06-13T18:00:56+08:00",
        "UpdateDate": "2024-01-03T16:36:09+08:00",
        "CertificateExpireTime": "2024-02-02T10:50:08+08:00"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode
错误码
错误信息
说明
400
InvalidParameter.SAMLProviderName
The specified parameter SAMLProviderName is invalid: The SAML provider does not EXIST

身份提供商不存在