Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Application Integration APIs/ OAuth 2.0 Authentication/ Obtaining User Information
Updated on 2024-12-30 GMT+08:00
View PDF
Share

Obtaining User Information

Function

This API is used to obtain user information.

Constraints

null

URI

GET /api/v1/oauth2/userinfo

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Authentication credential. The value is Bearer {access_token}.

Accept

Yes

String

Type of response that can be received. The value is application/json.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

id

String

User ID.

userName

String

Username.

name

String

Name.

email

String

Email address.

mobile

String

Mobile number.

Status code: 401

Table 3 Response body parameters

Parameter

Type

Description

error

String

Error type.

error_description

String

Error description.

Example Requests

Query user information based on access_token.

GET https://{domain_name}/api/v1/oauth2/userinfo

Authorization: Bearer b7e1fda8-33ce-432c-9b97-7ff035fac...
Accept: application/json

Example Responses

Status code: 200

Request successful.

{
  "id" : "20201029190841785-CB37-8BD36B...",
  "name" : "test",
  "userName" : "test",
  "mobile" : "12345678901",
  "email" : "123@example.com"
}

Status code: 401

Authentication failed.

{
  "error" : "unauthorized",
  "error_description" : "Full authentication is required to access this resource"
}

Status Codes

Status Code

Description

200

Request successful.

401

Authentication failed.

Error Codes

See Error Codes.

Parent topic: OAuth 2.0 Authentication