API v1 ReferenceProject Roles

Creates a new project role.

Creates a new project role. <Info title="Subscription Level">This endpoint requires the Standard plan or higher.</Info> <Check title="Required Permissions">The user must be an admin or have `workspace-manage-config:write` permissions.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The model used to create a project role.
namestringRequired>=0 characters<=255 characters
The name of the project role. Required.
isDefaultboolean or nullOptional
Whether to use this role as default when adding new project members.
defaultProjectRoleIdstring or nullOptionalformat: "uuid"
The id of the new default project role. Required if the updated project role is the current default role.
allowOnlyProjectMasterDataReadbooleanOptional

Whether this role is allowed to have only read permissions for project-master-data.

Response

OK
namestring>=0 characters<=255 characters
The name of the project role. Required.
isDefaultboolean or null
Whether to use this role as default when adding new project members.
defaultProjectRoleIdstring or nullformat: "uuid"
The id of the new default project role. Required if the updated project role is the current default role.
allowOnlyProjectMasterDataReadboolean or null

Whether this role is allowed to have only read permissions for project-master-data.

idstring or nullformat: "uuid"
The id of the project role.
memberCountinteger or null
The count of members which are linked to this role.
memberslist of objects or null
The members which are linked to this role.
createdOnstring or nullformat: "date-time"
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOnstring or nullformat: "date-time"
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.