You are here

public function Users::getRoles in Auth0 Single Sign On 8.2

Get all roles assigned to a specific user. Required scopes:

  • "read:users"
  • "read:roles"

@link https://auth0.com/docs/api/management/v2#!/Users/get_user_roles

Parameters

string $user_id User ID to get roles for.:

array $params Additional listing params like page, per_page, and include_totals.:

Return value

mixed

Throws

EmptyOrInvalidParameterException Thrown if the user_id parameter is empty or is not a string.

\Exception Thrown by the HTTP client when there is a problem with the API call.

File

vendor/auth0/auth0-php/src/API/Management/Users.php, line 257

Class

Users
Class Users. Handles requests to the Users endpoint of the v2 Management API.

Namespace

Auth0\SDK\API\Management

Code

public function getRoles($user_id, array $params = []) {
  $this
    ->checkEmptyOrInvalidString($user_id, 'user_id');
  $params = $this
    ->normalizePagination($params);
  $params = $this
    ->normalizeIncludeTotals($params);
  return $this->apiClient
    ->method('get')
    ->addPath('users', $user_id)
    ->addPath('roles')
    ->withDictParams($params)
    ->call();
}