auth0/dist/esm/management/__generated/managers/users-by-email-manager.js

SDK for Auth0 API v2

import * as runtime from '../../../lib/runtime.js';
const { BaseAPI } = runtime;
/**
 *
 */
export class UsersByEmailManager extends BaseAPI {
    /**
     * If Auth0 is the identify provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it. For example, if you register a user as <b>JohnSmith@example.com</b>, Auth0 saves the user's email as <b>johnsmith@example.com</b>.
     *
     * In cases where Auth0 is not the idP, the `email` is stored based on the rules of idP, so make sure the search is made using the correct capitalization.
     *
     * When using this endpoint, make sure that you are searching for users via email addresses using the correct case.
     *
     * Search Users by Email
     *
     * @throws {RequiredError}
     */
    async getByEmail(requestParameters, initOverrides) {
        runtime.validateRequiredRequestParams(requestParameters, ['email']);
        const queryParameters = runtime.applyQueryParams(requestParameters, [
            {
                key: 'fields',
                config: {},
            },
            {
                key: 'include_fields',
                config: {},
            },
            {
                key: 'email',
                config: {},
            },
        ]);
        const response = await this.request({
            path: `/users-by-email`,
            method: 'GET',
            query: queryParameters,
        }, initOverrides);
        return runtime.JSONApiResponse.fromResponse(response);
    }
}
//# sourceMappingURL=users-by-email-manager.js.map