See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Roles >
  5. List Roles

List Roles

Use this API to return a list of roles.

This endpoint supports pagination and sorting.



Resource URL

https://<subdomain>/api/2/roles

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: Manage All, Read All, Read Users.

Query Parameters

Max page limit is 650. See Pagination for detail on how this works.

Many of the search tools described in our Getting Started documentation can be applied to your parameters, allowing you to fine-tune your results.

name

string

Optional. Filters by role name.

app_id

integer

Optional. Returns roles that contain this app ID.

app_name

string

Optional. Returns roles that contain this app name.

fields

string

Optional. Comma delimited list of fields to return.

Valid options are apps, users, admins.

Sample Responses

  • 200 OK
  • 401 Unauthorized
[
  {
      "id": 123,
      "name": "Sample Role",
      "apps": [ 123, 456,...]
  }    
  ...
]

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

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

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.

Sample Code

cURL

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

List Mappings

curl 'https://<subdomain>/api/2/roles' \
-X GET \
-H "Authorization: bearer <access_token>"

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.