Log In via Authorization Code¶

Log in to the Application Portal via authorization code.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/login-via-code

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
code	Mandatory	String	The authorization code.

Response Parameters¶

Name	Data Type	Description
data	Data Struct	The details of the user.

Data Struct¶

Name	Data Type	Description
organizations	Array of IdNamePair Structs	The list of organizations that the user belongs to.
user	IdNamePair Struct	The ID and name of the user.
accessToken	String	The access token (or bearer token).

IdNamePair Struct¶

Name	Data Type	Description
id	String	The organization/user ID.
name	String	The organization/user name.

Error Code¶

Code	Description
31400	Invalid authorization code.
31429	Accessing with incorrect password or IP attempt limit reached. Please try again later.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/login-via-code
method: POST
requestBody:
{"code":"authorizationCode"}

Return Sample¶

{
  "code": 0,
  "data": {
    "accessToken": "APP_PORTAL_S_WX89rC4pqsMc478tyP6gb9zFmT9qYaW7",
    "organizations": [
      {
        "id": "yourOrgId_1",
        "name": "Portal Demo"
      },
      {
        "id": "yourOrgId_2",
        "name": "rm_0726_001"
      }
    ],
    "user": {
      "id": "yourUserId",
      "name": "portal_demo"
    }
  },
  "message": ""
}