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.

Limited Availability

This API is only available as a very limited preview and is currently closed.



Resource URL

POST https://<subdomain>/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.

Content-Type

required

string

Set to application/json.

Resource Parameter

id

required

string

Set to the id of the privilege.

Request Parameters

roles

required

array

Array of role_ids to which the privilege will be assigned

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://<subdomain>/api/1/privileges/<privilege_id>/roles' \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
    "roles": [123, 456, 789]
}'

Postman Collection

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

Run in Postman

    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.

ask


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.