User Roles

The user roles API allows you to retrieve and manage user assignments to roles, in order to grant them permissions to perform user based actions within V3.

The User Role Resource

Properties

Name
user_id
Required
Type
integer
Description
Unique identifier for the user who the profile belongs to
Name
roles
Required
Type
array
Description
Name
id
Required
Type
integer
Description
The unique ID of the role.
Name
name
Required
Type
string
Description
The user friendly name of the role assigned to a user
Name
slug
Required
Type
string
Description
The machine friendly name of the role assigned to a user

User Role Resource

{
  "user_id": 1,
  "roles": [
    {
      "id": 2,
      "name": "Test Role",
      "slug": "test-role",
    }
  ]
}

GET/v2/users/:user_id/roles

Retrieve User Roles

Will return a collection of all roles assigned to a user. If no roles are assigned to a user, an empty array will be returned.

URL Parameters

Name
user_id
Required
required
Type
integer
Description
User ID to retrieve roles for

Error Codes

Status	Description
404	The requested user.

Request

GET

/v2/users/:user_id/roles

use Compliance\Sdk\ApexV3\Contracts\ApexV3SdkInterface;
use Compliance\Sdk\Authentication\Types\Machine;

private ApexV3SdkInterface $sdk;

$response = $this->sdk
  ->v2(new Machine())
  ->user(1)
  ->roles()
  ->get();

Response

{
  "user_id": 1,
  "roles": [
    {
      "id": 2,
      "name": "Test Role",
      "slug": "test-role",
    }
  ]
}