获取子用户登录态

最近更新时间:2017-12-21 21:18:02

获取用户登录态(GetUserSession)

描述

获取用户登录态

返回API概览

请求参数

名称 类型 必须 长度限制(字符) 参数格式 描述
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:GetUserSession
UserName String 最短1,最长64 [\w+=,.@-]+ 等待获取登录态IAM用户名,未指定调用时会依据AKId推测用户名
EmbeddedSession String 最短2,最长3 [Yes|No] 返回的Session是否仅在Embedded控制台有效,默认是No
Duration int 最小60,最大900 int 返回连接有效时间,默认60s
CallbackType String - [REDIRECT|JSONP] 返回url的类型,返回支持302的重定向和JSONP的访问。默认302从定向
CallbackUrl String 4096 url地址 如果是REDIRECT模式,生成callback地址

返回元素(调用成功)

名称 类型 描述
UserSession UserType 登录Session信息

错误码(调用不成功)

错误代码(Code) 错误消息(Message) HTTP 状态码 中文描述(语义)
UserBadGenerationSession Fail to generate the login session. 500 服务器生成用户session失败

示例

请求示例
https://iam.api.ksyun.com/?Action=GetUserSession&UserName=Bob&公共请求参数
返回示例
  • XML格式
<GetUserSessionResponse>
    <GetUserSessionResult>
        <Url>http://embedded.ksyun.com/checksession?AccountId=73406424&Code=872579651</Url>
        <Expiration>2017-09-04T11:12:49Z</Expiration>
    </GetUserSessionResult>
    <ResponseMetadata>
        <RequestId>67113f08-24da-41f2-8130-8bbf1eeb4295</RequestId>
    </ResponseMetadata>
</GetUserSessionResponse>
  • JSON示例
{
    "GetUserSessionResult": {
        "Url": "http://embedded.ksyun.com/checksession?AccountId=73406424&Code=2227559128",
        "Expiration": "2017-09-04T11:12:20Z"
    },
    "RequestId": "3c1221a9-debe-45ee-9d92-cc76acd04119"
}

金山云,开启您的云计算之旅

注册有礼