Choose Organization


用户在登录应用门户后,选择需要进入的 OU。

仅当用户登录并进入一个 OU 后,才可以获取用户的有效 Access Token 信息。

前提条件


用户需要登录应用门户。可通过 Log In API 登录应用门户。

请求格式


POST https://{apigw-address}/app-portal-service/v2.2/session/set

请求参数(URI)


名称

位置(Path/Query)

必需/可选

数据类型

描述

channel

Query

可选

String

用户登录来源。支持指定以下参数:

  • EnOS-Mobile:EnOS 移动端。

  • WeCom:微信。

  • Web:EnOS 应用门户。

如需自定义其它登录来源,可联系系统管理员。

请求参数(Body)


名称

必需/可选

数据类型

描述

orgId

必需

String

需要进入的 OU ID。如何获取 orgId 信息 >>

响应参数


名称

数据类型

描述

userId

String

用户 ID。

userName

String

用户名称。

currentOrgId

String

当前 OU ID。

currentOrgName

String

当前 OU 名称。

accessToken

String

用户账号的 Access Token。

refreshToken

String

可用于刷新当前 Access Token 的 Refresh Token。

refreshTokenExpire

Long

Refresh Token 的过期时间。以 UTC 时间表示,格式见 UTC 采用的 ISO8601 标准时间格式

错误码


代码

错误信息

描述

31400

orgId is required

OU ID 不能为空

31401

Please login first

请先登录

31404

Can not find this organization.

未找到对应 OU

示例

请求示例


url: https://{apigw-address}/app-portal-service/v2.2/session/set?channel=web

method: POST

headers: {"Authorization":"Bearer your_token"}

requestBody:
{"orgId":"yourOrgId"}

返回示例


{
  "code": 0,
  "message": "OK",
  "data": {
    "userId": "your_user_id",
    "userName": "your_user_name",
    "currentOrgId": "your_org_id",
    "currentOrgName": "your_org_name",
    "accessToken": "your_access_token",
    "refreshToken": "your_refresh_token",
    "refreshTokenExpire": 1570018958000
  }
}