List roles

GET

List available user roles in an Organization.

Path parameters

organizationIdstringRequired

The Organization’s ID.

Query parameters

includeDefaultRolesbooleanOptional

Whether to include default Astro roles in the returned list.

scopeTypesenumOptional

Filter the list of roles based on the scope of each role.

Allowed values: DEPLOYMENTWORKSPACEORGANIZATION
offsetintegerOptional>=0

Offset for pagination.

limitintegerOptional>=0

Limit for pagination.

sortsenumOptional

Sorting criteria, each criterion should conform to format ‘fieldName:asc’ or ‘fieldName:desc’.

Response

OK

limitinteger

The number of custom roles returned.

offsetinteger

The offset of the custom roles.

roleslist of objects

The list of custom roles.

totalCountinteger

The total number of custom roles.

defaultRoleslist of objectsOptional

The list of default roles.

Built with