Get User Info
Use this API to get the user information related to a given access_token
.
Note that the user info return by this call is determined by the scopes
that were used to generate the access_token
Resource URL
https://<subdomain>.onelogin.com/oidc/2/me
Header Parameter
Authorization required string | Set to The |
Resource Parameter
subdomain required string |
Set to the e.g. |
Sample Response
- 200 OK
- 400 Bad Request
- 401 Unauthorized
The openid profile & email scopes were supplied in initial authorization
{
"sub": "32916209",
"email": "peggy.sue@onelogin.com",
"preferred_username": "peggy.sue",
"name": "Peggy Sue",
"updated_at": 1590019767000,
"given_name": "Peggy",
"family_name": "Sue",
"groups": [
"Admin Role",
"User Role",
"Custom Roll"
]
}
No scopes were supplied in initial authorization
{}
Authorization header is missing
{
"error": "invalid_request",
"error_description": "no bearer token provided"
}
Authorization header value needs to be “Bearer access_token
”
{
"error": "invalid_request",
"error_description": "invalid authorization header value format"
}
{
"error": "invalid_token",
"error_description": "invalid token provided"
}
Response Elements
sub |
The OneLogin ID for the user that started the session |
email |
The email address of the user |
preferred_username |
The username for the user. Not always an email address. |
name |
The full name of the user |
updated_at |
The unix epoch timestamp when the users profile was last updated. |
given_name |
The first name of the user |
family_name |
The last name of the user |
groups |
If the groups scope was supplied during authentication and the Groups parameter has been mapped on your OpenId Connect app in OneLogin then the groups claim will be returned. |
Sample Code
cURL
Replace sample values indicated by < >
with your actual values.
curl -XGET "https://<subdomain>.onelogin.com/oidc/2/me" \
-H "Authorization: Bearer <access_token>"
Postman Collection
Replace sample variables indicated by {{ }}
with your actual values.
Download for the OpenId Connect API
Have a Question?
Found a problem or a bug? Submit a support ticket.
Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.
Have a product idea or request? Share it with us in our Ideas Portal.