Get User Information¶

Get the information of an user.

Prerequisites¶

The user has logged in to Application Portal and entered an OU. You can log in to Application Portal through the Log In API and select the OU through the Choose Organization API.

Request Format¶

GET https://{apigw-address}/app-portal-service/v2.2/user/info

Request Parameters (Header)¶

Name	Required/Optional	Data Type	Description
Authorization	Required	String	The access token generated after the user logs in and selects the OU, represented by Bearer Token, is in the form of `Bearer {your token}`. You can call the Log In or Refresh Access Token API to obtain the access token.

Response Parameters¶

Name	Data Type	Description
id	String	The user ID.
name	String	The user name.
domain	String	The domain name.
description	String	The description of the user.
nickName	String	The nickname of the user.
phoneArea	String	The area code of the user’s registered phone number.
phone	String	The user’s registered phone number.
email	String	The user’s registered email address.
createdTime	String	The time when this user account was created.
joinTime	String	The time the user joined the current OU.
type	Integer	User account type. `0` indicates that the account is an account registered in Application Portal, `1` indicates that the account is a third-party domain account.
updatedTime	String	The update time of the user information.
company	String	The company of the user.
department	String	The department of the user.
position	String	The position of the user.

Error Codes¶

Code	Message	Description
31401	Please login first	Login first to get the valid Access Token.
31512	Organization unselected	Selecting an OU is required.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/user/info
headers: {"Authorization":"Bearer your_token"}
method: GET

Return Sample¶

{
  "code": 0,
  "message": "",
  "data": {
    "id": "your_user_id",
    "name": "your_user_name",
    "domain": "",
    "description": "",
    "nickName": "",
    "phoneArea": "",
    "phone": "",
    "email": "your_user_email",
    "createdTime": "2019-05-27 04:33:30.0",
    "type": 0,
    "company": "",
    "department": "",
    "position": ""
  }
}