Remove one or more members from a permission set

DELETE

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

Remove one or more users/teams from a permission set.

Path Parameters:

permission_set_id (uuid): ID of the permission set.

Request Body:

members (list, required): one or more {subject_type, subject_id}
objects. subject_type is "user" or "team".

Request Headers:

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

Behaviour (partial success):
Each member is processed independently. A member fails (and is skipped) when
the subject_id is malformed or no membership exists on this set.

Returns:

permission_set_id, removed (list of {subject_type, subject_id}),
failed (list of {subject_type, subject_id, error}), and unassigned_at
under data.

Response Header X-Authorization-Consistency-Token (str): SpiceDB
consistency token from the last write. Pass it to subsequent reads for
read-after-write consistency.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200

application/json

Member unassigned successfully

Bodyapplication/json

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "permission_set_id": "5849c88b-869e-4e24-b3b2-65918c11a4a7",
        "removed": [
            {
                "subject_type": "string",
                "subject_id": "string"
            }
        ],
        "failed": [
            {
                "subject_type": "string",
                "subject_id": "string",
                "error": "string"
            }
        ],
        "unassigned_at": "2019-08-24T14:15:22.123Z"
    }
}

Assign one or more members to a permission set