API Reference
Rockets Core API
nestjs-federated
classes
FederatedOAuthService

Class: FederatedOAuthService

Implements

  • FederatedOAuthServiceInterface

Constructors

new FederatedOAuthService()

new FederatedOAuthService(userLookupService, userMutateService, federatedService, federatedMutateService): FederatedOAuthService

Parameters

ParameterType
userLookupServiceFederatedUserLookupServiceInterface
userMutateServiceFederatedUserMutateServiceInterface
federatedServiceFederatedService
federatedMutateServiceFederatedMutateService

Returns

FederatedOAuthService

Defined in

.tmp/repos/rockets/packages/nestjs-federated/src/services/federated-oauth.service.ts:24 (opens in a new tab)

Properties

PropertyModifierType
federatedMutateServicepublicFederatedMutateService
federatedServicepublicFederatedService
userLookupServicepublicFederatedUserLookupServiceInterface
userMutateServicepublicFederatedUserMutateServiceInterface

Methods

createUser()

protected createUser(email, username, queryOptions?): Promise<FederatedCredentialsInterface>

Internal

Create a user

Parameters

ParameterType
emailstring
usernamestring
queryOptions?QueryOptionsInterface

Returns

Promise<FederatedCredentialsInterface>

Defined in

.tmp/repos/rockets/packages/nestjs-federated/src/services/federated-oauth.service.ts:105 (opens in a new tab)


createUserWithFederated()

protected createUserWithFederated(provider, email, subject, queryOptions?): Promise<FederatedCredentialsInterface>

Internal

Logic to create user and federated

Parameters

ParameterType
providerstring
emailstring
subjectstring
queryOptions?QueryOptionsInterface

Returns

Promise<FederatedCredentialsInterface>

Defined in

.tmp/repos/rockets/packages/nestjs-federated/src/services/federated-oauth.service.ts:82 (opens in a new tab)


sign()

sign(provider, email, subject, queryOptions?): Promise<FederatedCredentialsInterface>

Sign in with federated creating a user if it doesn't exist

Parameters

ParameterTypeDescription
providerstringprovider name (github, facebook, google)
emailstringemail account
subjectstringsubject (user id/ profile id from provider)
queryOptions?QueryOptionsInterfaceQuery options

Returns

Promise<FederatedCredentialsInterface>

Implementation of

FederatedOAuthServiceInterface.sign

Defined in

.tmp/repos/rockets/packages/nestjs-federated/src/services/federated-oauth.service.ts:41 (opens in a new tab)