Get Started
Product
Resources
Tools & SDKs
Framework
Reference

retrieveProviderIdentity - Auth Module Reference

This documentation provides a reference to the retrieveProviderIdentity 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 a provider identity by its ID.

Example#

Code
const providerIdentity = await authModuleService.retrieveProviderIdentity("provider_123")

Parameters#

idstring

The ID of the provider identity.

configFindConfig<ProviderIdentityDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<ProviderIdentityDTO>

The retrieved provider identity.

Was this page helpful?