⚠️ 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

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.xml

Parameters

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}.xml