roles

Returns users of the specified role.

Changed on

Returns users of the specified role. The result lists users 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}/users

Request

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

Path parameters

roleIdstring uuid required

The id of the role.

Query parameters

showArchivedboolean

Whether to show archived users.

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

userIdstring uuid required

The id of the user to add to the role.

isDeactivatedboolean

Whether the user is deactivated in this role.

roleIdstring uuid

The id of the role the user is assigned to.

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 GetRoleUsersByRoleId removed and replaced with roles_GetRoleUsersByRoleId