Roles

Update role

Updates an existing role with new permissions, users, and project assignments.

put/api/roles/{roleId}

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/:roleId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

roleIdstring uuid required

Unique identifier of the role to update

Request body

namestring required

Updated name of the role

descriptionstring

Updated description of the role

idpGroupsstring[] nullable

Updated identity provider groups to map to this role

projectPermissionsstring[]

Updated list of project-level permissions to grant

usersstring[]

Updated list of user IDs to assign to this role

allProjectsboolean required

Whether this role should apply to all projects

projectsstring[]

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

Response

The updated 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

Changes

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