Get User Information


Get the information of the current user.

Operation Permissions


  • User login to Application Portal is required.

  • Selecting an OU is required.

Request Format


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

Request Parameters (Header)


Name

Mandatory/Optional

Data Type

Description

Authorization

Mandatory

String

The access token (or bearer token). The format of the parameter’s string is Bearer {your token}. Refer to Log In or Refresh Access Token to learn how to get the access token.

Response Parameters


Name

Data Type

Description

data

Data Struct

The information of the user

company

String

The company of the user

department

String

The department of the user

position

String

The position of the user

Data Struct


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

createdTime

String

The time when this user account was created

joinTime

String

The time the user joined the current organization

type

Integer

The user type

  • 0 = Application Portal account

  • 1 = Third-party domain account

updatedTime

String

The update time of the user information.

Error Codes


Code

Message

Description

31401

Please login first

Login first to get 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":"yourBearerToken"}
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": ""
  }
}