You are here

public function Connections::deleteUser in Auth0 Single Sign On 8.2

Delete a specific User for a Connection. Required scope: "delete:users"

@link https://auth0.com/docs/api/management/v2#!/Connections/delete_users_by_e...

Parameters

string $id Auth0 database Connection ID (user_id with strategy of "auth0").:

string $email Email of the user to delete.:

Return value

mixed|string

Throws

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

File

vendor/auth0/auth0-php/src/API/Management/Connections.php, line 137

Class

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

Namespace

Auth0\SDK\API\Management

Code

public function deleteUser($id, $email) {
  return $this->apiClient
    ->method('delete')
    ->addPath('connections', $id)
    ->addPath('users')
    ->withParam('email', $email)
    ->call();
}