You need to enable JavaScript to run this app.
导航
CreateSAMLProvider - 创建 SAML 身份提供商
最近更新时间:2024.02.23 13:58:52首次发布时间:2024.02.23 13:58:52

创建 SAML 身份提供商

调试

请求参数

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

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

CreateSAMLProvider

要执行的操作,取值:CreateSAMLProvider

Version
String

2018-01-01

API的版本,取值:2018-01-01

EncodedSAMLMetadataDocument
String

PD94bWwg...

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

SAMLProviderName
String

my-provider

SAML 身份提供商名称

Description
String

身份提供商描述

SSOType
Integer

身份提供商 SSO 类型

  1. 角色 SSO
  2. 用户 SSO
Status
Integer

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

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

返回参数

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

参数
类型
示例值
描述
Trn
String

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

身份提供商 Trn

SAMLProviderName
String

my-provider

SAML 身份提供商名称

SSOType
Integer

身份提供商 SSO 类型

  1. 角色 SSO
  2. 用户 SSO
Status
Integer

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

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

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

创建时间

UpdateDate
String

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

更新时间

Description
String

身份提供商描述

请求示例

GET '/?Action=CreateSAMLProvider&Version=2018-01-01' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'SAMLProviderName=test-provider' \
--data-urlencode 'EncodedSAMLMetadataDocument=PD94bWwg...' \
--data-urlencode 'Description=test' \
--data-urlencode 'Status=1' \
--data-urlencode 'SSOType=1'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202401191150550102252431470183A0D5",
        "Action": "CreateSAMLProvider",
        "Version": "2018-01-01"
    },
    "Result": {
        "Trn": "trn:iam::2100000000:saml-provider/test-provider",
        "SAMLProviderName": "test-provider",
        "SSOType": 1,
        "Status": 1,
        "Description": "test",
        "CreateDate": "2024-01-03T16:10:57+08:00",
        "UpdateDate": "2024-01-03T16:10:57+08:00"
    }
}

错误码

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

HttpCode
错误码
错误信息
说明
400
SensitiveWord.SAMLProviderName
Sensitive Word in Identity Provider Name.

身份提供商名称不符合规定,请修改后重试

400
InvalidParameter
The specified parameter is invalid

接口参数不合法

400
QuotaExceeded.RoleSAMLProvider
The count of RoleSAMLProvider has exceeded the quota.

角色身份提供商数量超过配额

400
QuotaExceeded.UserSAMLProvider
The count of UserSAMLProvider has exceeded the quota.

用户身份提供商数量超过配额

400
InvalidParameter.EncodedSAMLMetadataDocument
The specified parameter EncodedSAMLMetadataDocument is invalid

SAML 元数据文件不合法

400
InvalidParameter.EncodedSAMLMetadataDocument.Cert
The specified parameter EncodedSAMLMetadataDocument is invalid

SAML 元数据文件证书不合法