Skip to main content

tw roles

Manage workspace roles. Custom roles are not available for Seqera Cloud Basic organizations.

tw roles list​

List predefined and custom roles

tw roles list [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-o, --organizationOrganization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'.Yes
-t, --typeRole type to list (predefined or custom).No
-f, --filterShow only roles whose name contains the given text (* wildcards allowed).No
--pagePage number for paginated results (default: 1)No
--offsetRow offset for paginated results (default: 0)No
--maxMaximum number of records to display (default: 100)No

tw roles view​

View a role and its permissions

tw roles view [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-o, --organizationOrganization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'.Yes
-n, --nameRole name.Yes

tw roles add​

Add a custom role

tw roles add [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-o, --organizationOrganization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'.Yes
-n, --nameCustom role name. Must be unique within the organization and different from the predefined role names.Yes
-d, --descriptionCustom role description (max 120 characters).Yes
-p, --permissionsComma-separated list of permissions granted by the role. See 'tw roles permissions' for the available names.Yes

tw roles update​

Update a custom role

tw roles update [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-o, --organizationOrganization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'.Yes
-n, --nameCustom role name.Yes
--new-nameNew custom role name.No
-d, --descriptionNew custom role description (max 120 characters).No
-p, --permissionsComma-separated list of permissions. Replaces the current permissions of the role.No

tw roles delete​

Delete a custom role

tw roles delete [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-o, --organizationOrganization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'.Yes
-n, --nameCustom role name.Yes

tw roles permissions​

List the permissions that can be granted by a custom role

tw roles permissions [OPTIONS]

Options​

OptionDescriptionRequiredDefault
-o, --organizationOrganization name or numeric ID. Specify either the unique organization name or the numeric organization ID returned by 'tw organizations list'.Yes