roles

Returns permissions of the specified role.

Changed on

Returns permissions of the specified role. The result lists permissions assigned to the role.

<Check title="Required Permissions" icon="key">The user must be an admin or have workspace-manage-config:read permissions.</Check>

get/roles/{roleId}/permissions

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/roles/{roleId}/permissions
  • Auth: HTTP bearer

Path parameters

roleIdstring uuid required

The id of the role.

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

featurestring nullable

The feature these permissions belong to.

accessLevelsstring[] nullable

The access levels applied to this feature.

idstring uuid

The id of the permission.

createdOnstring date-time

The date this entity was created.

updatedOnstring date-time

The date this entity was last modified.

subdomainsstring[] nullable

The workspace's subdomains. Read-only.

identityIdsstring[] nullable

The ids of identities assigned to this workspace. Read-only.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetRolePermissionsByRoleId removed and replaced with roles_GetRolePermissionsByRoleId