See api-docs Menu

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 Role by ID

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

Resource URL





Set to the role’s ID with .xml appended. For example, 123456.xml. If you don’t know the role’s id, use the Get all roles API call to return all roles and their id values.

Sample Response

    <title>No such role</title>
    <message>No role found by id 476</message>

Response Elements


Role’s unique ID in OneLogin.


Role name.

Sample cURL Request

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

curl -u {api-key}:x -X GET{role_id}.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.