See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Users >
  5. List Custom Attributes

List Custom Attributes

Use this API to get a list of custom attributes in a OneLogin account.

Resource URL

https://<subdomain>/api/2/users/custom_attributes

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.

Sample Responses

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 422 Unprocessable Entity
[
    {
        "name": "Personal Email",
        "id": 87846,
        "position": 1,
        "shortname": "personalemail"
    },
    {
        "name": "Work Email",
        "id": 87845,
        "position": 2,
        "shortname": "workemail"
    },
    {
        "name": "Linked Account",
        "id": 85306,
        "position": 3,
        "shortname": "linkedaccount"
    }
]

An invalid search parameter was used.

{
    "message": "query parameter(s) not allowed: first_login",
    "name": "BadRequestError",
    "statusCode": 400
}

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

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

You cant sort on this field.

{
    "message": "Invalid sort field: created_at",
    "field": "created_at",
    "name": "UnprocessableEntityFieldError",
    "statusCode": 422
}

Postman Collection

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

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.