List of Roles

Authorizations

Authorization

string

header

required

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

Query Parameters

filter[id]

string

filter[created_before]

string

filter[created_after]

string

filter[updated_before]

string

filter[updated_after]

string

filter[deleted_before]

string

filter[deleted_after]

string

filter[trashed]

string

Can be a value of with (response will contain deleted items as well), only (will contain only deleted items), or any arbitrary value (will contain only not deleted items).

sort

enum<string>[]

Available options:

id,

-id,

policy_type,

-policy_type,

integration_id,

-integration_id,

name,

-name,

handle,

-handle,

integration_reference,

-integration_reference,

created_at,

-created_at,

updated_at,

-updated_at,

-id,

--id,

-policy_type,

--policy_type,

-name,

--name,

-handle,

--handle,

-integration_reference,

--integration_reference,

-created_at,

--created_at,

-updated_at,

--updated_at

filter

string

filter[policy_type]

string

Filter by policy type

filter[integration_id]

string

Filter by integration ID

filter[integration_type]

string

Filter by integration type (polymorphic morph class)

filter[name]

string

Filter by an exact match of the display name field

filter[handle]

string

Filter by an exact match of the display name field

filter[integration_reference]

string

Filter by an exact match of the display name field

Response

The collection of 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

Authorizations

Query Parameters

Response