Patch Permission Group

patch

https://{application_vanity_domain}/api/v1/permission-groups/{permissionGroupId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Patches the specified permission group.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

Permission	Boundary	Description
permission-group:update	Application	The subject can update the permission groups for the application to which the subject belongs.
	Tenant	The subject can update the permission groups owned by the tenant to which the subject belongs.
	Tenant Inclusion List	The subject can update permission groups owned by tenants specified in the tenant inclusion list.
	Tenant Exclusion List	The subject can update the permission groups owned by tenants that belong to the subject's application but are not on the tenant exclusion list.

Path Params

permissionGroupId

string

required

length between 1 and 26

The Id of the permission group.

Body Params

Permission group patch request adhering to the JSON Merge Patch specification.

Permission Group

ownerType

string

enum

length between 1 and 30

[Required on Create] The type of the owner of the resource.

Allowed:

ownerId

string

length between 1 and 26

[Required on Create] The ID of the owner of the resource.

name

string

length between 1 and 40

^[a-zA-Z0-9]+(-+[a-zA-Z0-9]+)*$

[Required on Create] The name of the permission group. Name must be unique (case-insensitive) within an application.
Application-level permission groups are prefixed with app:<app_domain_name>:, and tenant-level permission groups
are prefixed with tnt:<tnt_domain_name>:.

displayName

string

length between 1 and 60

[Required on Create] The display name of the permission group.

description

string

length between 1 and 500

Optional description of the permission group.

permissionBoundaryId

string

length ≤ 26

Optional ID of the permission boundary that is assigned to this permission group.

tenantVisibility

string

enum

length between 1 and 45

[Required on Create] Enum representing the tenants that this permission boundary should be visible to.

ALL: The permission group is visible to all tenants and can also be assigned to any tenant-level roles.
NONE: The permission group is not visible to any tenants and cannot be assigned to any tenant-level roles.
OWNER: Indicates that the permission group is only visible to the tenant that owns it.

Allowed:

Headers

If-Match

string

length ≥ 1

Used to perform a conditional update

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Required Permissions

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

406Not Acceptable

409Conflict

412Precondition Failed

415Unsupported Media Type

500Internal Server Error

503Service Unavailable