Skip to main content
PATCH
Update group member status

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_ -]+$
groupName
string
required

The unique identifier of the group Group name pattern. Allows any character except / (would split the FGA resource path — see ResourceIdentifier.parseFromFga) and * (FGA wildcard). Length cap of 70 covers both user-defined groups (max 63 chars, enforced by Validators.isValidString) and workspace-derived groups (workspace name 1-63 + "-group" suffix).

Pattern: ^(?!.*\*)(?!.*[/]).{1,70}$
memberName
string
required

The group member identifier. Either a user (user:{email}) or a nested group (group:{groupName}). Parsed by UserGroupId in the controller. User or group identifier pattern (user must be valid email address, group is standard identifier)

Pattern: ^(user:[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}|group:[a-zA-Z0-9._-]+)$

Body

application/json
status
enum<string>

The new status for the member

Available options:
admin,
member

Response

Member status updated successfully