POST
Assign Roles
Try it with your credentials Fills <placeholders> in code examples on this page
Subdomain saved in browser • Access token tab-only • Client ID & Secret never stored. Details —
Use this API to assign a privilege to one or more roles.
This is a useful way to bulk assign privileges to many users.
Required Feature
A OneLogin subscription that includes Delegated Administration is required to use the privileges API.
Resource URL
POST https://<subdomain>.onelogin.com/api/1/privileges/:id/roles
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]
}
```html
<h2 id="sampleresponse">Sample Response</h2>
<div class="tab-group">
<ul class="tab-links">
<li class="t-link status-200 active" data-tab="1">201 Created</li>
<li class="t-link status-400" data-tab="2">400 Bad Request</li>
<li class="t-link status-401" data-tab="3">401 Unauthorized</li>
</ul>
<div class="tab-views">
<div class="t-view active" data-tab="1">
```json
{
"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>.onelogin.com/api/1/privileges/<privilege_id>/roles' \
-X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{
"roles": [123, 456, 789]
}'
```xml
<h2 id="postman-collection">Postman Collection</h2>
[<img src=https://run.pstmn.io/button.svg alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/2629710-bc8bb742-e7bb-4582-8d24-03cd315b1024?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D2629710-bc8bb742-e7bb-4582-8d24-03cd315b1024%26entityType%3Dcollection%26workspaceId%3D2a9bbc3a-4259-4faf-9f51-0b7ca1df3fd0)
Have a Question?
Looking for walkthroughs or how-to guides? Check out our Knowledge Base.
Have a product idea or request? Share it in our Ideas Portal.