See api-docs Menu

Get User

Use this API to get back a single user from a OneLogin account.

Early Preview

This API is in early preview and may be subject to change.









Resource URL

https://<api-domain>/api/2/users/:id

Header Parameters

Authorization

required

string

Set to bearer:<access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Read Users, Manage users, Read All, or Manage All.

Resource Parameters

id

required

integer

Set to the id of the user that you want to return.

If you don’t know the user’s id, use the List Users API call to return all users and their id values.

Sample Responses

{
    "activated_at": "2017-12-12T23:59:28.665Z",
    "distinguished_name": null,
    "external_id": null,
    "firstname": "Kelly",
    "last_login": "2020-06-03T19:59:21.382Z",
    "lastname": "Slater",
    "company": "WSL",
    "directory_id": null,
    "invitation_sent_at": null,
    "member_of": null,
    "updated_at": "2020-07-09T03:08:52.774Z",
    "preferred_locale_code": null,
    "created_at": "2017-12-12T23:57:56.781Z",
    "userprincipalname": null,
    "trusted_idp_id": null,
    "comment": "",
    "title": "Surfer",
    "role_ids": [
        199848,
        272445
    ],
    "department": "Waves",
    "id": 36216766,
    "custom_attributes": {
        "employeenumber": null,
        "food": "chicken"
    },
    "invalid_login_attempts": 0,
    "manager_user_id": null,
    "locked_until": "2020-07-08T21:59:56.811Z",
    "username": "kellyslater",
    "manager_ad_id": null,
    "email": "kelly+preprod@onelogin.com",
    "phone": "+64272001122",
    "state": 1,
    "group_id": null,
    "password_changed_at": "2019-08-22T18:44:26.542Z",
    "status": 3,
    "samaccountname": null
}

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "name": "UnauthorizedError",
    "statusCode": 401
}
{
    "message": "The resource with the given id could not be found",
    "name": "NotFoundError",
    "statusCode": 404
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Users API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

curl 'https://<api-domain>/api/2/users/<id>' \
-X GET \
-H "Authorization: bearer:<access_token>"

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.