Skip to main content

Change Project Role

PUT 
https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/:roleKey

Change a project role. The key is not editable. If a key should change, remove the role and create a new one.

Request​

Path Parameters

    projectId stringrequired
    roleKey stringrequired

    The key is the only relevant attribute for ZITADEL regarding the authorization checks.

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data.

Body

required

    displayName stringrequired

    Possible values: non-empty and <= 200 characters

    group string

    Possible values: <= 200 characters

    The group is only used for display purposes. That you have better handling, like giving all the roles from a group to a user.

Responses​

A successful response.

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/roles/:roleKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "displayName": "Administrator",
  "group": "Admins"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— pathrequired
— header
Body required
{
  "displayName": "Administrator",
  "group": "Admins"
}
ResponseClear

Click the Send API Request button above and see the response here!