Update a Role

curl --request PATCH \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/policy/roles/{role} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "integration_reference": "<string>",
  "sort_order": 10
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/policy/roles/{role}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
  "name": "<string>",
  "handle": "<string>",
  "integration_reference": "<string>",
  "sort_order": 10
}'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/policy/roles/{role}"

payload = {
    "name": "<string>",
    "handle": "<string>",
    "integration_reference": "<string>",
    "sort_order": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    handle: '<string>',
    integration_reference: '<string>',
    sort_order: 10
  })
};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/policy/roles/{role}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "porol_01hq8xyzabc123def456ghi789",
  "policy_type": "directory_attribute",
  "integration_id": "<string>",
  "integration_type": "<string>",
  "name": "<string>",
  "handle": "<string>",
  "integration_reference": "<string>",
  "sort_order": 10,
  "is_imported": true,
  "count": [
    "<string>"
  ],
  "timestamp": {
    "created_at": "2025-01-28T13:37:00Z",
    "updated_at": "2025-05-04T03:27:00Z",
    "deleted_at": null
  },
  "links": {
    "self": "https://ws-a1b2c3.provisionr.io/api/v1/policy/roles/porol_01hq8xyzabc123def456ghi789"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

PATCH

policy

roles

{role}

Update a Role

curl --request PATCH \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/policy/roles/{role} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "integration_reference": "<string>",
  "sort_order": 10
}
'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/policy/roles/{role}' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
  "name": "<string>",
  "handle": "<string>",
  "integration_reference": "<string>",
  "sort_order": 10
}'

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/policy/roles/{role}"

payload = {
    "name": "<string>",
    "handle": "<string>",
    "integration_reference": "<string>",
    "sort_order": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    handle: '<string>',
    integration_reference: '<string>',
    sort_order: 10
  })
};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/policy/roles/{role}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "porol_01hq8xyzabc123def456ghi789",
  "policy_type": "directory_attribute",
  "integration_id": "<string>",
  "integration_type": "<string>",
  "name": "<string>",
  "handle": "<string>",
  "integration_reference": "<string>",
  "sort_order": 10,
  "is_imported": true,
  "count": [
    "<string>"
  ],
  "timestamp": {
    "created_at": "2025-01-28T13:37:00Z",
    "updated_at": "2025-05-04T03:27:00Z",
    "deleted_at": null
  },
  "links": {
    "self": "https://ws-a1b2c3.provisionr.io/api/v1/policy/roles/porol_01hq8xyzabc123def456ghi789"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

role

string

required

Policy Role ID

Body

application/json

UpdatePolicyRoleRequestData

name

string

Title Case human readable name

Maximum string length: 63

handle

string

alpha-dash string that is similar to the name or uses shorthand abbreviations. If not set, the name will be converted to alpha-dash format

Maximum string length: 55

integration_reference

string

The vendor-specific name or ID used in API queries

Maximum string length: 255

sort_order

integer | null

Sort order for display purposes. Lower numbers appear first

Example:

10

Response

PolicyRoleDetailedResponseData

string

required

Example:

"porol_01hq8xyzabc123def456ghi789"

policy_type

enum<string>

required

The policy type that this role applies to


`directory_attribute` Provisionr Dimension Attribute. This acts as a reusable ruleset for other Attributes, Groups or Resources
`google_workspace_group` Google Workspace Group. This is used for Workspace Groups that can be used for email distribution lists and access management.
`okta_group` Okta Group. This is used for managing members of a group that is assigned to one or more to Okta Apps.

Available options:

directory_attribute,

google_workspace_group,

okta_group

integration_id

string | null

required

The ID of the integration that this role is associated with (polymorphic)

integration_type

string | null

required

The type of the integration that this role is associated with (polymorphic)

name

string

required

Title Case human readable name

handle

string

required

alpha-dash string that is similar to the name or uses shorthand abbreviations

integration_reference

string | null

required

The vendor-specific name or ID used in API queries

sort_order

integer | null

required

Sort order for display purposes. Lower numbers appear first

Example:

10

is_imported

boolean

required

Whether this is a system-defined role (true) or user-created (false)

Example:

true

count

string[]

required

Count of related records.

This is empty for now but reserved for future use and consistency with API patterns

Minimum array length: 1

timestamp

TimestampBasicData · object

required

The timestamps for the role record

Show child attributes

links

object

required

API hyperlinks related to the role record

Show child attributes

Example:

{
  "self": "https://ws-a1b2c3.provisionr.io/api/v1/policy/roles/porol_01hq8xyzabc123def456ghi789"
}

Getting Started

Endpoints

Update a Role

Authorizations

Path Parameters

Body

Response