public function Roles::delete in Auth0 Single Sign On 8.2

Delete a single Role by ID. Required scope: "delete:roles"

@link https://auth0.com/docs/api/management/v2#!/Roles/delete_roles_by_id

Parameters

string $role_id Role ID to delete.:

Return value

mixed

Throws

EmptyOrInvalidParameterException Thrown if the 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/Roles.php, line 98

Class

Roles

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

Namespace

Auth0\SDK\API\Management

Code

public function delete($role_id) {
  $this
    ->checkEmptyOrInvalidString($role_id, 'role_id');
  return $this->apiClient
    ->method('delete')
    ->addPath('roles', $role_id)
    ->call();
}