Update a Privilege

Use this API to update an existing privilege object.

For a detailed explanation of a privilege object, see Create a Privilege.

Required Feature

A OneLogin subscription that includes Delegated Administration is required to use the privileges API.

Resource URL

PUT https://<subdomain>.onelogin.com/api/1/privileges/:id

Header Parameters

Authorization required string	Set to Bearer <access_token>. Set <access_token> to the access token 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 using the Manage All scope.
Content-Type required string	Set to application/json.

Resource Parameter

id required string

Set to the id of the privilege you want to update.

Request Parameters

name required string	The name of this privilege
description string	The description for this privilege
privilege required object	An object containing statements that describe the level of access granted by this privilege. Version - The version for the privilege schema. This is always 2018-05-18. Statement - An array of statment objects. For a detailed explanation of a Statement object, including possible Actions, see Create a Privilege.

Sample Request Body

Allow the following user actions on any user in OneLogin.

{
	"name": "User Administrator",
  "description": "Can administer users",
	"privilege":  {
		"Version": "2018-05-18",
		"Statement": [{
			"Effect": "Allow",
			"Action": [
				"users:Get",
				"users:Unlock",
				"users:ResetPassword",
				"users:ForceLogout",
				"users:Delete"
			],
			"Scope": ["*"]
		}]
	}
}
```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">200 OK</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
{
    "id": "5e43a548-e9c6-47be-9341-92160902f7a6"
}

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

{
    "statusCode": 400,
    "name": "BadRequestError",
    "message": "The request could not be understood by the server due to malformed syntax: Effect is required and must be 'Allow'"
}

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

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

curl 'https://<subdomain>.onelogin.com/api/1/privileges/<privilege_id>' \
-X PUT \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
	"name": "Super Administrator",
  "description": "Can do super things",
	"privilege":  {
		"Version": "2018-05-18",
		"Statement": [{
			"Effect": "Allow",
			"Action": ["*"],
			"Scope": ["*"]
		}]
	}
}'
```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)