See api-docs Menu

Assign Roles

Use this API to assign a privilege to one or more roles.

This is a useful way to bulk assign privileges to many users.

Preview Release

This API is part of the OneLogin Delegated Administration Service and only available as a preview release. If you’re interested in using this API please contact your account manager or our support team.

Resource URL

POST https://api.<us_or_eu>.onelogin.com/api/1/privileges/:id/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.

Generate the access token with the API credential pair created using the scope required to call this API. Call this API with the Manage All scope.

Resource Parameter

id

required

string

Set to the id of the privilege.

Sample Request Body

Add the following roles to the privilege.

{
    "roles": [123, 456, 789]
}

Sample Response

{
    "success": true
}

Check request body and content-type is set to application/json.

{
    "statusCode": 400,
    "name": "BadRequestError",
    "message": "The request could not be understood by the server due to malformed syntax"
}

Typically, this error indicates an invalid access token.

{
    "statusCode": 401,
    "name": "UnauthorizedError",
    "message": "The request requires user authentication."
}

Sample Code

cURL

curl 'https://api.<us_or_eu>>.onelogin.com/api/1/privileges/<privilege_id>/roles' \
-X POST \
-H "Authorization: bearer:<access_token>" \
-d '{
    "roles": [123, 456, 789]
}'

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Privileges API


Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.