Auth0-PHP

UsersByEmailInterface
in

Interface UsersByEmailInterface.

Table of Contents

get()  : ResponseInterface
Search Users by Email.

Methods

get()

Search Users by Email.

public get(string $email[, RequestOptions|null $options = null ]) : ResponseInterface

Required scope: read:users.

Parameters
$email : string

email address to search for (case-sensitive)

$options : RequestOptions|null = null

Optional. Additional request options to use, such as a field filtering or pagination. (Not all endpoints support these. See @see for supported options.)

Tags
throws
ArgumentException

when an invalid email is provided

throws
NetworkException

when the API request fails due to a network error

see
https://auth0.com/docs/api/management/v2#!/Users_By_Email/get_users_by_email
Return values
ResponseInterface

Search results