IAM API ReferenceRole

List roles

List available user roles in an Organization.

Path parameters

organizationIdstringRequired

The Organization’s ID.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

includeDefaultRolesbooleanOptional

Whether to include default Astro roles in the returned list.

scopeTypeslist of enumsOptional

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

Allowed values:
offsetintegerOptional>=0Defaults to 0

Offset for pagination.

limitintegerOptional>=0Defaults to 20

Limit for pagination.

sortslist of enumsOptional

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.

Errors