Log In¶
Log in the account.
Request Format¶
POST https://{apigw-address}/app-portal-service/v2.0/login
Request Parameters (Body)¶
Name | Required or Not | Data Type | Description |
---|---|---|---|
account | true | String | User name |
password | true | String | Password of the user name |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | data struct | User information |
data Struct¶
Name | Data Type | Description |
---|---|---|
organizations | IdNamePair struct | List of organizations that the user belongs to |
user | IdNamePair struct | User information |
accessToken | String | Access Token, represented as Bearer Token |
IdNamePair Struct¶
Name | Data Type | Description |
---|---|---|
id | String | User ID |
name | String | User name |
Sample¶
Request Sample¶
POST
https://{apigw-address}/app-portal-service/v2.0/login
{"account":"portal_demo","password":"Test1234"}
Return Sample¶
{
"code": 200,
"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": ""
}