Roles

Create role

Creates a new role with the specified permissions and project assignments.

post/api/roles

Request

The document declares no server URL.
Auth
- HTTP bearer
- or HTTP internal
TypeScript
https://skmtc.dev/gorules/apis/gorules-agent-api/docs/api/roles/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

Name of the role

descriptionstring

Description of the role

idpGroupsstring[] nullable

Identity provider groups to map to this role

projectPermissionsstring[]

List of project-level permissions to grant

allProjectsboolean required

Whether this role should apply to all projects

usersstring[]

List of user IDs to assign to this role

projectsstring[]

List of project IDs this role applies to (ignored if allProjects is true)

The created role

idstring uuid required

Unique identifier of the role

namestring required

Name of the role

descriptionstring nullable

Description of the role

idpGroupsstring[] nullable

Identity provider groups mapped to this role

allProjectsboolean required

Whether this role applies to all projects

projectPermissionsstring[] nullable

List of project-level permissions granted by this role

organisationIdstring uuid required

ID of the organisation this role belongs to

createdAtstring required

Timestamp when the role was created

updatedAtstring required

Timestamp when the role was last updated

No recorded changes to this operation across all 1 revision of this API.