GetSigninToken
调用GetSigninToken使用安全令牌获取登录令牌。
接口说明
该接口为登录类接口,请求结构为
https://signin.aliyun.com/federation?Action=xx&Parameters
。
Action:要执行的操作。
Parameters:API自定义请求参数,不包含公共参数。
该接口无需签名。
该接口中的请求参数必须为x-www-form-urlencoded格式,否则调用时会报错。
请求参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetSigninToken | 操作接口名,系统规定参数,取值:GetSigninToken。 |
AccessKeyId | String | 是 | STS.L4a*******vFDw | 安全令牌的AccessKeyId。 |
AccessKeySecret | String | 是 | wyLTS********Z9 | 安全令牌的AccessKeySecret。 |
SecurityToken | String | 是 | CAESr********MnLIl | 安全令牌。 |
TicketType | String | 是 | 必须传入mini。 |
返回参数
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
SigninToken | String | 5aW96ZW/5a*******9rZW7lkYA= | 登录Token,默认30秒过期,且仅能使用一次 |
SigninToken的有效时长由AccessKeyId、AccessKeySecret的有效时长决定。临时的AccessKeyId、AccessKeySecret通过角色扮演获取,因此您可以通过修改
接口中的
参数来设置AccessKeyId、AccessKeySecret的有效时间。
请求示例
https://signin.aliyun.com/federation?Action=GetSigninToken
&AccessKeyId=STS.L4a*******vFDw
&AccessKeySecret=wyLTS*******Z9
&SecurityToken=CAESr*******MnLIl
&TicketType=mini
返回示例
JSON格式
{
"RequestId": "04F0F3E73368",
"SigninToken": "5aW96ZW/5a*******9rZW7lkYA="
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidAction | The action GetSigninToken is invalid. | 接口错误 |
400 | MissingParameter.AccessKeyId | The parameter AccessKeyId is missing. | 参数AccessKeyId缺失 |
400 | MissingParameter.AccessKeySecret | The parameter AccessKeySecret is missing. | 参数AccessKeySecret缺失 |
400 | MissingParameter.SecurityToken | The parameter SecurityToken is missing. | 参数SecurityToken缺失 |
401 | InvalidCredential.AuthenticateFail | The credential you provided is invalid. | 认证信息错误,认证失败。 |
401 | InvalidCredential.Expired | The credential you provided is expired. | 认证信息过期,认证失败。 |
400 | InvalidParameter | Some parameters are invalid. | 参数错误 |