API ReferenceOrganizations

IAM - Update Organization Member

Update the roles that a member holds on the organization.

Authentication

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

Path Parameters

org_idstringRequiredformat: "uuid"
memberstringRequired

Request

This endpoint expects an object.
addlist of enumsOptional

A list of organization roles to grant to the member.

Roles in this list are applied to the member AFTER any removals specified in remove.

This may be combined with remove_all to replace the member’s entire role list.

Allowed values:
removelist of enumsOptional
A list of organization roles to revoke from the member.
Allowed values:
remove_allboolean or nullOptionalDefaults to false

Removes all existing roles from the member. This may be combined with add to replace all existing roles that the member holds.

Response

Successful Response
memberstring

The member identifier string, the format of which is ‘<subject_type>:<subject_id>’

roleslist of strings or null
A list of roles that the member holds on an entity. Some entities, such as Organizations, may contain members that exist without any roles.
namestring or null
The name of the member.
avatar_urlstring or null
If avatar of the member, if it is supported by their subject type.
total_subjectsinteger or nullDefaults to 1

The total number of subjects that the member represents, which may be a value other than 1 if the member is not a User.

Errors