Skip to main content

Change Project Role​

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

Path Parameters
  • projectId string required
  • roleKey string required

    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.

Request Body required
  • displayName string required

    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
PUT /projects/:projectId/roles/:roleKey

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/management/v1
Bearer Token
projectId — path required
roleKey — path required
x-zitadel-orgid — header
Content-Type
Body required
{

  "displayName": "Administrator",

  "group": "Admins"

}
Accept
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/projects/:projectId/roles/:roleKey' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "displayName": "Administrator",
  "group": "Admins"
}'