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

Remove one or more roles from a specific user. Required scope: "update:users"

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

Parameters

string $user_id User ID to remove roles from.:

array $roles Array of permissions to remove.:

Return value

mixed

Throws

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

EmptyOrInvalidParameterException Thrown if the roles parameter is empty.

\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 286

Class

Users

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

Namespace

Auth0\SDK\API\Management

Code

public function removeRoles($user_id, array $roles) {
  $this
    ->checkEmptyOrInvalidString($user_id, 'user_id');
  if (empty($roles)) {
    throw new EmptyOrInvalidParameterException('roles');
  }
  $data = [
    'roles' => $roles,
  ];
  return $this->apiClient
    ->method('delete')
    ->addPath('users', $user_id)
    ->addPath('roles')
    ->withBody(json_encode($data))
    ->call();
}