更新 SAML 身份提供商

调试

请求参数

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

const columns = [
  {
    width: '9%',
    title: '参数',
    dataIndex: 'Name',
  },
  {
    width: '9%',
    title: '类型',
    dataIndex: 'DataType',
  },
  {
    width: '9%',
    title: '是否必填',
    dataIndex: 'IsRequired',
  },
  {
    width: '18%',
    title: '示例值',
    dataIndex: 'Example',
  },
  {
    width: '55%',
    title: '描述',
    dataIndex: 'Description',
  },
];

const data = [
  { 
    rowKey: '->Action',
    Name: 'Action',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"UpdateSAMLProvider"} />,
    Description: <RenderMd content={"要执行的操作，取值：UpdateSAMLProvider"} />,
    children: [
    ]
  },
  { 
    rowKey: '->Version',
    Name: 'Version',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"2018-01-01"} />,
    Description: <RenderMd content={"API的版本，取值：2018-01-01"} />,
    children: [
    ]
  },
  { 
    rowKey: '->SAMLProviderName',
    Name: 'SAMLProviderName',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"待更新 SAML 身份提供商名称"} />,
    children: [
    ]
  },
  { 
    rowKey: '->NewEncodedSAMLMetadataDocument',
    Name: 'NewEncodedSAMLMetadataDocument',
    DataType: 'String',
    IsRequired: '否',
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"SAML 身份提供商元数据文件 Base64 编码"} />,
    children: [
    ]
  },
  { 
    rowKey: '->Description',
    Name: 'Description',
    DataType: 'String',
    IsRequired: '否',
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"身份提供商描述"} />,
    children: [
    ]
  },
  { 
    rowKey: '->Status',
    Name: 'Status',
    DataType: 'Integer',
    IsRequired: '否',
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"身份提供商状态 (仅用户 SSO)\n1. 开启\n2. 开启并禁用其他登录方式\n3. 关闭"} />,
    children: [
    ]
  },
  
];

return (<Table
  rowKey="rowKey"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  pagination={false}
/>);

返回参数

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

const columns = [
  {
    title: '参数',
    dataIndex: 'Name',
    width: '10%',
  },
  {
    title: '类型',
    dataIndex: 'DataType',
    width: '10%',
  },
  {
    title: '示例值',
    dataIndex: 'Example',
    width: '20%',
  },
  {
    title: '描述',
    dataIndex: 'Description',
    width: '60%',
  },
];
    
const data = [
  { 
    rowKey: "->Trn",
    Name: "Trn",
    DataType: "String",
    Example: <RenderMd content={"trn:iam::2100000000:saml-provider/my-provider"} />,
    Description: <RenderMd content={"身份提供商 Trn"} />,
    children: [
    ]
  },
  { 
    rowKey: "->SAMLProviderName",
    Name: "SAMLProviderName",
    DataType: "String",
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"SAML 身份提供商名称"} />,
    children: [
    ]
  },
  { 
    rowKey: "->SSOType",
    Name: "SSOType",
    DataType: "Integer",
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"身份提供商 SSO 类型\n1. 角色 SSO\n2. 用户 SSO"} />,
    children: [
    ]
  },
  { 
    rowKey: "->Status",
    Name: "Status",
    DataType: "Integer",
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"身份提供商状态 (仅用户 SSO)\n1. 开启\n2. 开启并禁用其他登录方式\n3. 关闭"} />,
    children: [
    ]
  },
  { 
    rowKey: "->Description",
    Name: "Description",
    DataType: "String",
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"身份提供商描述"} />,
    children: [
    ]
  },
  { 
    rowKey: "->CreateDate",
    Name: "CreateDate",
    DataType: "String",
    Example: <RenderMd content={"2024-01-03T16:10:57+08:00"} />,
    Description: <RenderMd content={"创建时间"} />,
    children: [
    ]
  },
  { 
    rowKey: "->UpdateDate",
    Name: "UpdateDate",
    DataType: "String",
    Example: <RenderMd content={"2024-01-03T16:10:57+08:00"} />,
    Description: <RenderMd content={"更新时间"} />,
    children: [
    ]
  },
];

return (<Table
  rowKey="rowKey"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  pagination={false}
/>);

请求示例

GET '/?Action=UpdateSAMLProvider&Version=2018-01-01' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'SAMLProviderName=test' \
--data-urlencode 'NewEncodedSAMLMetadataDocument=PD94bWwgdmVyc2lv' \
--data-urlencode 'Description=test' \
--data-urlencode 'Status=1'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202205191150550102252431470183A0D5",
        "Action": "UpdateSAMLProvider",
        "Version": "2018-01-01"
    },
    "Result": {
        "Trn": "trn:iam::2100000000:saml-provider/test",
        "SAMLProviderName": "test",
        "SSOType": 1,
        "Status": 1,
        "Description": "test",
        "CreateDate": "2023-06-13T18:00:56+08:00",
        "UpdateDate": "2024-01-03T16:36:09+08:00"
    }
}

错误码

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

const columns = [
  {
    title: 'HttpCode',
    dataIndex: 'HttpCode',
    width: '9%',
  },
  {
    title: '错误码',
    dataIndex: 'ErrorCode',
    width: '13%',
  },
  {
    title: '错误信息',
    dataIndex: 'ErrorMessage',
    width: '39%',
  },
  {
    title: '说明',
    dataIndex: 'Description',
    width: '39%',
  },
];
    
const data = [
  { 
    HttpCode: 400,
    ErrorCode: 'SensitiveWord.SAMLProviderName',
    ErrorMessage: "Sensitive Word in Identity Provider Name.",
    Description: <RenderMd content={"身份供应商名称不符合规定，请修改后重试"} />,
  },
  { 
    HttpCode: 400,
    ErrorCode: 'InvalidParameter.EncodedSAMLMetadataDocument.Cert',
    ErrorMessage: "The specified parameter EncodedSAMLMetadataDocument is invalid",
    Description: <RenderMd content={"SAML 元数据文件证书不合法"} />,
  },
  { 
    HttpCode: 400,
    ErrorCode: 'InvalidParameter.EncodedSAMLMetadataDocument',
    ErrorMessage: "The specified parameter EncodedSAMLMetadataDocument is invalid",
    Description: <RenderMd content={"SAML 元数据文件不合法"} />,
  },
];

return (<Table
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  pagination={false}
/>);