See api-docs Menu
  1. Home >
  2. API >
  3. v1-v3 >
  4. Roles >
  5. Get All Roles

v1-v3 APIs have been deprecated

Don't worry, these APIs are deprecated, but they aren't shut off yet.

All new development with APIs should use the newest version of our API: /1. API /1 is based on RESTful principles, is secured by OAuth 2.0, and provides JSON messages, search, pagination, sorting, and filtering.

Get All Roles

Users have one or more roles assigned to them. Roles determine which apps are available users. For more info, see Roles.

Resource URL

https://api.onelogin.com/api/v1/roles.xml

Sample Response

  • 200 OK
<roles type="array">
    <role>
            <id>12345</id>
            <name>Employee</name>
    </role>
<!-- clip -->
    <role>
            <id>54321</id>
            <name>Manager</name>
    </role>
</roles>

Response Elements

id

Role’s unique ID in OneLogin.

name

Role name.

Sample cURL Request

Be sure to replace placeholder values surrounded by { } with actual values.

curl -u {api_key}:x -X GET https://api.onelogin.com/api/v1/roles.xml

Postman Collection

Be sure to set Postman-specific environment variables indicated by {{ }}.

Download for the Roles 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.