Retrieve a permission set

GET

/api/v2/permission-sets/{permission_set_id}

Retrieve a single permission set by its ID.

Path Parameters:

permission_set_id (uuid): ID of the permission set to retrieve.

Request Headers:

X-Organization-Id (int, optional): Override the org scoping these permission sets.
Requires manage (admin) access to the specified organization.

X-Authorization-Consistency-Token (string, optional): Authorization consistency token for read-after-write consistency. Pass the token received from a previous write operation to ensure this read reflects that write.

Returns:

The permission set object under data.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200

application/json

Permission set retrieved successfully

Bodyapplication/json

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/permission-sets/' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "organization_id": 0,
        "name": "string",
        "description": "string",
        "is_default": true,
        "is_system": true,
        "is_deleted": true,
        "permissions": {
            "property1": "string",
            "property2": "string"
        }
    }
}

Create a permission set

Update a permission set