v1-v3 APIs have been deprecated.
Although these APIs are not shut off yet, all new development with APIs should use the newest version of our API if available, and the version /1 in all other cases. These later versions are based on RESTful principles, secured by OAuth 2.0, and provide 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
Before calling this API, consider using its version /1 or version /2 equivalent.
https://api.onelogin.com/api/v1/roles/:role_id.xmlParameters
role_id required string |
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
- 200 OK
- 404 Not Found
<role>
<id>123456</id>
<name>Employee</name>
</role><error>
<title>No such role</title>
<message>No role found by id 476</message>
</error>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/{role_id}.xmlPostman Collection
- 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.