Interface IUsersClient

Defines the contract for a client that interacts with the Auth0 Management API's user endpoints. An instance of this client is typically created with a user-specific management token.

interface IUsersClient {
getUser(parameters: GetUserParameters): Promise<User>;
patchUser(parameters: PatchUserParameters): Promise<User>;
}

Index

Methods

getUser patchUser

Methods

getUser

getUser(parameters: GetUserParameters): Promise<User>
Retrieves the full profile of a user from the Management API.
Parameters
- parameters: GetUserParameters
  The parameters containing the user's ID.
Returns Promise<User>
A promise that resolves with the user's full profile.
- Defined in core/interfaces/IUsersClient.ts:15

patchUser

patchUser(parameters: PatchUserParameters): Promise<User>
Updates a user's user_metadata.
Parameters
- parameters: PatchUserParameters
  The parameters containing the user's ID and the metadata to update.
Returns Promise<User>
A promise that resolves with the updated user profile.
- Defined in core/interfaces/IUsersClient.ts:23

Interface IUsersClient

Index

Methods

Methods

getUser

Parameters

Returns Promise<User>

patchUser

Parameters

Returns Promise<User>

Settings

On This Page