User
User information endpoints
The user model
The user model contains all the information about user.
Properties
- Name
email- Type
- string,null
- Description
No description provided.
- Name
email_verified- Type
- boolean,null
- Description
No description provided.
- Name
family_name- Type
- string,null
- Description
No description provided.
- Name
given_name- Type
- string,null
- Description
No description provided.
- Name
name- Type
- string,null
- Description
No description provided.
- Name
phone- Type
- string,null
- Description
No description provided.
- Name
phone_verified- Type
- boolean,null
- Description
No description provided.
- Name
picture- Type
- string,null
- Description
No description provided.
- Name
preferred_username- Type
- string,null
- Description
No description provided.
- Name
sub- Type
- string
- Description
No description provided.
GET/userinfo
UserInfo Endpoint (GET)
Returns information about the authenticated user. This endpoint returns claims about the authenticated end-user based on the scopes of the access token.
Request
GET
/userinfocurl -G https://api.example.com/userinfo \
-H "Authorization: Bearer {token}"
Response
{
"id": "123456",
"name": "Example",
"created_at": 1591478057
}
POST/userinfo
UserInfo Endpoint (POST)
Returns information about the authenticated user. This endpoint returns claims about the authenticated end-user based on the scopes of the access token.
Request
POST
/userinfocurl https://api.example.com/userinfo \
-H "Authorization: Bearer {token}"
Response
{
"id": "123456",
"name": "Example",
"created_at": 1591478057
}