roles

Returns the role for the name.

Changed on

Returns the role for the name. The name match is evaluated within the current workspace.

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

get/roles/{roleName}

Request

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

Path parameters

roleNamestring required

The name of the role.

Response

OK

namestring required

The name of the role. Must be unique.

isAdminRoleboolean

Whether this is the admin role. Only one role can be the admin role.

isGuestRoleboolean

Whether this is the guest role. Only one role can be the guest role.

idstring uuid

The id of the role.

isAgentRoleboolean

Whether this is a retained role from the legacy agent-as-user model. The role cannot be modified.

isPresetboolean

Whether this role is one of the preset roles. Preset roles can be edited, archived and deleted.

isArchivedboolean

Whether the role has been archived.

createdBystring uuid

The id of the user who created this role.

createdOnstring date-time

The date this role was created.

updatedBystring uuid

The id of the user who updated this role.

updatedOnstring date-time

The date this role was last modified.

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 GetRoleByRoleName removed and replaced with roles_GetRoleByRoleName