Roles

Roles define the permissions that organization members receive in Seqera Platform. Predefined roles are managed by the system, while custom roles can be created and maintained for an organization.

Use these endpoints to list predefined and custom roles, inspect assignable permissions, and create, update, validate, or delete custom roles in an organization context.

Use List role permissions as the discovery endpoint for the permission names accepted by Create role and Update role. Custom role changes apply at the organization level and can affect access across workspaces where the role is assigned.

Path and query parameters

Name	Type	Location	Req/Opt	Description
orgId	integer	query	Required	Organization numeric identifier.
max	integer	query	Optional	Maximum number of results to return. Default: 50. Maximum: 100.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
name	string	query	Optional	Role name search filter.
type	string	query	Optional	Role type filter.
roleName	string	path	Required	Role name.

Request body parameters

Name	Type	Req/Opt	Description
CreateRole			Create role
name	string	Optional	Custom role name. Must be unique in the organization and meet role name length and format requirements.
description	string	Optional	Custom role description. Must be between 1 and 120 characters.
permissions	array	Optional	Array of permission names assigned to the custom role.
UpdateRole			Update role
name	string	Optional	Updated custom role name. Must be unique in the organization and meet role name length and format requirements.
description	string	Optional	Updated custom role description. Must be between 1 and 120 characters.
permissions	array	Optional	Array of permission names assigned to the custom role.