Skip to main content

Add User Grant

POST 
https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants

Add a user grant for a specific user. User grants are the roles users have for a specific project and organization.

Request​

Path Parameters

    userId stringrequired

Header Parameters

    x-zitadel-orgid string

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

Body

required

    projectId stringrequired

    Possible values: non-empty and <= 200 characters

    projectGrantId string

    Possible values: <= 200 characters

    Make sure to fill in the project grant id if the user grant is for a granted project and the organization is not the owner of the project.

    roleKeys string[]

Responses​

A successful response.

Schema

    userGrantId string

    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 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/grants' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "projectId": "58949026806489455",
  "projectGrantId": "9847026806489455",
  "roleKeys": [
    "RoleKey1",
    "RoleKey2"
  ]
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— header
Body required
{
  "projectId": "58949026806489455",
  "projectGrantId": "9847026806489455",
  "roleKeys": [
    "RoleKey1",
    "RoleKey2"
  ]
}
ResponseClear

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