Class Users

Auth0 Management API User endpoints

Export

See

https://auth0.com/docs/api/management/v2#!/Users/ Users

Index

Methods

getUser patchUser

Methods

getUser

getUser(parameters: GetUserOptions): Promise<User>
Returns the user by identifier
Parameters
- parameters: GetUserOptions
  
  get user by identifier parameters
  - [key: string]: any
  - Optionalheaders?: Record<string, string>
    
    (Optional) Custom headers to include in the request.
  - id: string
Returns Promise<User>

See

https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id

Memberof

Users
- Defined in management/users.ts:68

patchUser

patchUser(parameters: PatchUserOptions): Promise<User>
Patch a user's user_metadata
Parameters
- parameters: PatchUserOptions
  
  patch user metadata parameters
  - [key: string]: any
  - Optionalheaders?: Record<string, string>
    
    (Optional) Custom headers to include in the request.
  - id: string
  - metadata: object
Returns Promise<User>

See

https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id

Memberof

Users
- Defined in management/users.ts:92

Settings

Member Visibility

Theme