文档中心 API 中心 访问管理 STS相关接口 根据 SAML 断言申请角色临时凭证

根据 SAML 断言申请角色临时凭证

最近更新时间:2019-07-24 15:09:54

1. 接口描述

接口请求域名: sts.tencentcloudapi.com 。

本接口(AssumeRoleWithSAML)用于根据 SAML 断言申请角色临时凭证。

默认接口请求频率限制:200次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:sts.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AssumeRoleWithSAML
Version String 公共参数,本接口取值:2018-08-13
Region String 公共参数,详见产品支持的 地域列表
SAMLAssertion String base64 编码的 SAML 断言信息
PrincipalArn String 扮演者访问描述名
RoleArn String 角色访问描述名
RoleSessionName String 会话名称
DurationSeconds Integer 指定临时证书的有效期,单位:秒,默认 7200 秒,最长可设定有效期为 7200 秒

3. 输出参数

参数名称 类型 描述
Credentials Credentials 对象里面包含 Token,TmpSecretId,TmpSecretKey 三元组
ExpiredTime Integer 证书无效的时间,返回 Unix 时间戳,精确到秒
Expiration String 证书无效的时间,以 ISO8601 格式的 UTC 时间表示
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 SAML 断言申请角色临时凭证

输入示例

https://sts.tencentcloudapi.com/?Action=AssumeRoleWithSAML
&PrincipalArn=qcs::cam::uin/798950673:saml-provider/OneLogin
&RoleArn=qcs::cam::uin/798950673:roleName/OneLogin-Role
&RoleSessionName=test
&SAMLAssertion=c2FtbCBhc3NlcnRpb24=
&<公共请求参数>

输出示例

{
  "Response": {
    "Credentials": {
      "Token": "1siMD5r0tPAq9xpRlnzj4pjI8daS4MIW4dcd2a6a1ad76f09a0069002923def8aFw7tUMd2nH-yMZE5816oW7_Y-0JwI_ReMlkz-ajVxc_6MrXEYRtRShjDg5-L4Dq0ceupsIfdokiZG9EkfzO6Vt11iW0jLlPMT1pRFue",
      "TmpSecretId": "AKID65zyIP0mpXtaIFqt2SlWIQVMn1umNH58",
      "TmpSecretKey": "q95K84wrzuEGocfy39zg52boxvp71yoh"
    },
    "ExpiredTime": 1543914376,
    "Expiration": "2018-12-04T09:06:16Z",
    "RequestId": "4daec797-9cd2-4f09-9e7a-7d4c43b2a74c"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.DbError DB错误。
InternalError.EncryptError 加密失败。
InternalError.GetAppIdError 获取appid错误。
InternalError.GetRoleError 获取角色失败。
InternalError.GetSeedTokenError 获取种子token失败。
InternalError.IllegalRole 角色非法。
InternalError.PbSerializeError pb打包失败。
InternalError.SystemError 内部错误。
InternalError.UnknownError 未知错误。
InvalidParameter.AccountNotAvaliable 账号不存在或不可用。
InvalidParameter.ExtendStrategyOverSize 扩展策略过大。
InvalidParameter.GrantOtherResource 越权访问资源。
InvalidParameter.OverTimeError 过期时间超过阈值。
InvalidParameter.ParamError 参数错误。
InvalidParameter.PolicyTooLong 策略过长。
InvalidParameter.ResouceError 资源错误。
InvalidParameter.StrategyFormatError 策略语法错误。
InvalidParameter.StrategyInvalid 非法策略。
InvalidParameter.TempCodeNotAvaliable TCB temp code 无效。
ResourceNotFound.RoleNotFound 账号对应的角色不存在。
UnauthorizedOperation 未授权操作。