Add Project Role
Add a new project role to a project. The key must be unique within the project.
Path Parameters
- projectId string required
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.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- roleKey string required
Possible values:
non-empty
and<= 200 characters
The key is the only relevant attribute for ZITADEL regarding the authorization checks.
- 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.
Request Body required
- roleKey string required
Possible values:
non-empty
and<= 200 characters
The key is the only relevant attribute for ZITADEL regarding the authorization checks.
- 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.
Request Body required
- roleKey string required
Possible values:
non-empty
and<= 200 characters
The key is the only relevant attribute for ZITADEL regarding the authorization checks.
- 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.
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
{
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}