retrieveAuthIdentity - Auth Module Reference

This documentation provides a reference to the retrieveAuthIdentity method. This belongs to the Auth Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves an auth identity by its ID.

Example#

Code
const authIdentity = await authModuleService.retrieveAuthIdentity("authusr_1")

Parameters#

idstring

The ID of the auth identity.

configFindConfig<AuthIdentityDTO>Optional

The configurations determining how the auth identity is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a auth identity.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<AuthIdentityDTO>

The retrieved auth identity.