identity namespace

Funciones

Función Descripción
beforeOperation(eventType, optsOrHandler, controlador)
beforeUserCreated(handler) Controla un evento que se activa antes de la creación de un usuario.
beforeUserCreated(optas, controlador) Controla un evento que se activa antes de la creación de un usuario.
beforeUserSignedIn(controlador) Controla un evento que se activa antes de que un usuario acceda.
beforeUserSignedIn(optas, controlador) Controla un evento que se activa antes de que un usuario acceda.
getOpts(BlockingOptions)

Clases

Clase Descripción
HttpsError Un error explícito que puede arrojar un controlador para enviar un error al cliente que llamó a la función.

Interfaces

Interfaz Descripción
AuthBlockingEvent Define el evento de autenticación para los eventos de bloqueo de 2a gen.
AuthUserRecord El UserRecord que se pasa a las funciones de bloqueo de autenticación desde Identity Platform
BlockingOptions Todas las opciones de la función más idToken, accessToken y refreshToken.

Identity.beforeOperation()

Firma:

export declare function beforeOperation(eventType: AuthBlockingEventType, optsOrHandler: BlockingOptions | ((event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>), handler: (event: AuthBlockingEvent) => BeforeCreateResponse | BeforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;

Parámetros

Parámetro Tipo Descripción
eventType Tipo de evento de bloqueo de autenticación
optsOrHandler BlockingOptions | ((evento: AuthBlockingEvent) => beforeCreateResponse | beforeSignInResponse | void | Promise<BeforeCreateResponse> | Promise<BeforeSignInResponse> | Promise<void>)
handler (evento: AuthBlockingEvent) => beforeCreateResponse | AntesSignInResponse | void | Promesa<BeforeCreateResponse> | Promesa<BeforeSignInResponse> | Promesa<void>

Muestra:

Función de bloqueo

Identity.beforeUserCreated()

Controla un evento que se activa antes de la creación de un usuario.

Firma:

export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;

Parámetros

Parámetro Tipo Descripción
handler (evento: AuthBlockingEvent) => beforeCreateResponse | Promesa<BeforeCreateResponse> | void | Promesa<void> Controlador de eventos que se ejecuta cada vez antes de que se cree un usuario

Muestra:

Función de bloqueo

Identity.beforeUserCreated()

Controla un evento que se activa antes de la creación de un usuario.

Firma:

export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeCreateResponse | Promise<BeforeCreateResponse> | void | Promise<void>): BlockingFunction;

Parámetros

Parámetro Tipo Descripción
opciones BlockingOptions Objeto que contiene opciones de funciones
handler (evento: AuthBlockingEvent) => beforeCreateResponse | Promesa<BeforeCreateResponse> | void | Promesa<void> Controlador de eventos que se ejecuta cada vez antes de que se cree un usuario

Muestra:

Función de bloqueo

identidad.beforeUserSignedIn()

Controla un evento que se activa antes de que un usuario acceda.

Firma:

export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;

Parámetros

Parámetro Tipo Descripción
handler (evento: AuthBlockingEvent) => AntesSignInResponse | Promesa<BeforeSignInResponse> | void | Promesa<void> Controlador de eventos que se ejecuta cada vez antes de que acceda un usuario

Muestra:

Función de bloqueo

identidad.beforeUserSignedIn()

Controla un evento que se activa antes de que un usuario acceda.

Firma:

export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => BeforeSignInResponse | Promise<BeforeSignInResponse> | void | Promise<void>): BlockingFunction;

Parámetros

Parámetro Tipo Descripción
opciones BlockingOptions Objeto que contiene opciones de funciones
handler (evento: AuthBlockingEvent) => AntesSignInResponse | Promesa<BeforeSignInResponse> | void | Promesa<void> Controlador de eventos que se ejecuta cada vez antes de que acceda un usuario

Muestra:

Función de bloqueo

Identity.getOpts()

Firma:

export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;

Parámetros

Parámetro Tipo Descripción
Opciones de bloqueo BlockingOptions

Muestra:

Opciones internas