@accounts/graphql-api

@accounts/graphql-api › Globals

Index

Classes

• AuthenticatedDirective

Interfaces

• AccountsModuleConfig
• AccountsModuleContext
• AccountsPasswordModuleConfig
• AccountsRequest
• CoreAccountsModuleConfig
• SubscriptionResolverObject
• SubscriptionSubscriberObject

Type aliases

• AuthDirectiveArgs
• AuthDirectiveResolver
• AuthenticateParamsInput
• CreateUserInput
• CreateUserResult
• CreateUserResultResolvers
• DirectiveResolverFn
• DirectiveResolvers
• EmailRecord
• EmailRecordResolvers
• Exact
• IDirectiveResolvers
• IResolvers
• ImpersonateReturn
• ImpersonateReturnResolvers
• ImpersonationUserIdentityInput
• IsTypeOfResolverFn
• LoginResult
• LoginResultResolvers
• Maybe
• Mutation
• MutationAddEmailArgs
• MutationAuthenticateArgs
• MutationChangePasswordArgs
• MutationCreateUserArgs
• MutationImpersonateArgs
• MutationRefreshTokensArgs
• MutationResetPasswordArgs
• MutationResolvers
• MutationSendResetPasswordEmailArgs
• MutationSendVerificationEmailArgs
• MutationTwoFactorSetArgs
• MutationTwoFactorUnsetArgs
• MutationVerifyAuthenticationArgs
• MutationVerifyEmailArgs
• NextResolverFn
• Query
• QueryResolvers
• RequireFields
• Resolver
• ResolverFn
• ResolverTypeWrapper
• Resolvers
• ResolversParentTypes
• ResolversTypes
• Scalars
• SubscriptionObject
• SubscriptionResolveFn
• SubscriptionResolver
• SubscriptionSubscribeFn
• Tokens
• TokensResolvers
• TwoFactorSecretKey
• TwoFactorSecretKeyInput
• TwoFactorSecretKeyResolvers
• TypeResolveFn
• User
• UserInput
• UserResolvers

Variables

• AccountsModule
• AccountsPasswordModule
• CoreAccountsModule
• User

Functions

• authenticated
• context

Object literals

• Mutation
• Query

Type aliases

AuthDirectiveArgs

Ƭ AuthDirectiveArgs: object

Defined in packages/graphql-api/src/models.ts:307

Type declaration:

---

AuthDirectiveResolver

Ƭ AuthDirectiveResolver: DirectiveResolverFn‹Result, Parent, ContextType, Args›

Defined in packages/graphql-api/src/models.ts:309

---

AuthenticateParamsInput

Ƭ AuthenticateParamsInput: object

Defined in packages/graphql-api/src/models.ts:17

Type declaration:

• access_token? : Maybe‹Scalars["String"]›

• access_token_secret? : Maybe‹Scalars["String"]›

• code? : Maybe‹Scalars["String"]›

• password? : Maybe‹Scalars["String"]›

• provider? : Maybe‹Scalars["String"]›

• user? : Maybe‹UserInput›

---

CreateUserInput

Ƭ CreateUserInput: object

Defined in packages/graphql-api/src/models.ts:26

Type declaration:

• email? : Maybe‹Scalars["String"]›

• password? : Maybe‹Scalars["String"]›

• username? : Maybe‹Scalars["String"]›

---

CreateUserResult

Ƭ CreateUserResult: object

Defined in packages/graphql-api/src/models.ts:32

Type declaration:

• __typename? : "CreateUserResult"

• loginResult? : Maybe‹LoginResult›

• userId? : Maybe‹Scalars["ID"]›

---

CreateUserResultResolvers

Ƭ CreateUserResultResolvers: object

Defined in packages/graphql-api/src/models.ts:311

Type declaration:

• __isTypeOf? : IsTypeOfResolverFn‹ParentType›

• loginResult? : Resolver‹Maybe‹ResolversTypes["LoginResult"]›, ParentType, ContextType›

• userId? : Resolver‹Maybe‹ResolversTypes["ID"]›, ParentType, ContextType›

---

DirectiveResolverFn

Ƭ DirectiveResolverFn: function

Defined in packages/graphql-api/src/models.ts:257

Type declaration:

▸ (next: NextResolverFn‹TResult›, parent: TParent, args: TArgs, context: TContext, info: GraphQLResolveInfo): TResult | Promise‹TResult›

Parameters:

Name	Type
next	NextResolverFn‹TResult›
parent	TParent
args	TArgs
context	TContext
info	GraphQLResolveInfo

---

DirectiveResolvers

Ƭ DirectiveResolvers: object

Defined in packages/graphql-api/src/models.ts:402

Type declaration:

• auth? : AuthDirectiveResolver‹any, any, ContextType›

---

EmailRecord

Ƭ EmailRecord: object

Defined in packages/graphql-api/src/models.ts:38

Type declaration:

• __typename? : "EmailRecord"

• address? : Maybe‹Scalars["String"]›

• verified? : Maybe‹Scalars["Boolean"]›

---

EmailRecordResolvers

Ƭ EmailRecordResolvers: object

Defined in packages/graphql-api/src/models.ts:317

Type declaration:

• __isTypeOf? : IsTypeOfResolverFn‹ParentType›

• address? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• verified? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType›

---

Exact

Ƭ Exact: object

Defined in packages/graphql-api/src/models.ts:4

Type declaration:

---

IDirectiveResolvers

Ƭ IDirectiveResolvers: DirectiveResolvers‹ContextType›

Defined in packages/graphql-api/src/models.ts:411

deprecated Use "DirectiveResolvers" root object instead. If you wish to get "IDirectiveResolvers", add "typesPrefix: I" to your config.

---

IResolvers

Ƭ IResolvers: Resolvers‹ContextType›

Defined in packages/graphql-api/src/models.ts:401

deprecated Use "Resolvers" root object instead. If you wish to get "IResolvers", add "typesPrefix: I" to your config.

---

ImpersonateReturn

Ƭ ImpersonateReturn: object

Defined in packages/graphql-api/src/models.ts:44

Type declaration:

• __typename? : "ImpersonateReturn"

• authorized? : Maybe‹Scalars["Boolean"]›

• tokens? : Maybe‹Tokens›

• user? : Maybe‹User›

---

ImpersonateReturnResolvers

Ƭ ImpersonateReturnResolvers: object

Defined in packages/graphql-api/src/models.ts:323

Type declaration:

• __isTypeOf? : IsTypeOfResolverFn‹ParentType›

• authorized? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType›

• tokens? : Resolver‹Maybe‹ResolversTypes["Tokens"]›, ParentType, ContextType›

• user? : Resolver‹Maybe‹ResolversTypes["User"]›, ParentType, ContextType›

---

ImpersonationUserIdentityInput

Ƭ ImpersonationUserIdentityInput: object

Defined in packages/graphql-api/src/models.ts:51

Type declaration:

• email? : Maybe‹Scalars["String"]›

• userId? : Maybe‹Scalars["String"]›

• username? : Maybe‹Scalars["String"]›

---

IsTypeOfResolverFn

Ƭ IsTypeOfResolverFn: function

Defined in packages/graphql-api/src/models.ts:253

Type declaration:

▸ (obj: T, info: GraphQLResolveInfo): boolean | Promise‹boolean›

Parameters:

Name	Type
obj	T
info	GraphQLResolveInfo

---

LoginResult

Ƭ LoginResult: object

Defined in packages/graphql-api/src/models.ts:57

Type declaration:

• __typename? : "LoginResult"

• sessionId? : Maybe‹Scalars["String"]›

• tokens? : Maybe‹Tokens›

• user? : Maybe‹User›

---

LoginResultResolvers

Ƭ LoginResultResolvers: object

Defined in packages/graphql-api/src/models.ts:330

Type declaration:

• __isTypeOf? : IsTypeOfResolverFn‹ParentType›

• sessionId? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• tokens? : Resolver‹Maybe‹ResolversTypes["Tokens"]›, ParentType, ContextType›

• user? : Resolver‹Maybe‹ResolversTypes["User"]›, ParentType, ContextType›

---

Maybe

Ƭ Maybe: T | null

Defined in packages/graphql-api/src/models.ts:3

---

Mutation

Ƭ Mutation: object

Defined in packages/graphql-api/src/models.ts:64

Type declaration:

• __typename? : "Mutation"

• addEmail? : Maybe‹Scalars["Boolean"]›

• authenticate? : Maybe‹LoginResult›

• changePassword? : Maybe‹Scalars["Boolean"]›

• createUser? : Maybe‹CreateUserResult›

• impersonate? : Maybe‹ImpersonateReturn›

• logout? : Maybe‹Scalars["Boolean"]›

• refreshTokens? : Maybe‹LoginResult›

• resetPassword? : Maybe‹LoginResult›

• sendResetPasswordEmail? : Maybe‹Scalars["Boolean"]›

• sendVerificationEmail? : Maybe‹Scalars["Boolean"]›

• twoFactorSet? : Maybe‹Scalars["Boolean"]›

• twoFactorUnset? : Maybe‹Scalars["Boolean"]›

• verifyAuthentication? : Maybe‹Scalars["Boolean"]›

• verifyEmail? : Maybe‹Scalars["Boolean"]›

---

MutationAddEmailArgs

Ƭ MutationAddEmailArgs: object

Defined in packages/graphql-api/src/models.ts:109

Type declaration:

• newEmail: Scalars["String"]

---

MutationAuthenticateArgs

Ƭ MutationAuthenticateArgs: object

Defined in packages/graphql-api/src/models.ts:143

Type declaration:

• params: AuthenticateParamsInput

• serviceName: Scalars["String"]

---

MutationChangePasswordArgs

Ƭ MutationChangePasswordArgs: object

Defined in packages/graphql-api/src/models.ts:114

Type declaration:

• newPassword: Scalars["String"]

• oldPassword: Scalars["String"]

---

MutationCreateUserArgs

Ƭ MutationCreateUserArgs: object

Defined in packages/graphql-api/src/models.ts:83

Type declaration:

• user: CreateUserInput

---

MutationImpersonateArgs

Ƭ MutationImpersonateArgs: object

Defined in packages/graphql-api/src/models.ts:131

Type declaration:

• accessToken: Scalars["String"]

• impersonated: ImpersonationUserIdentityInput

---

MutationRefreshTokensArgs

Ƭ MutationRefreshTokensArgs: object

Defined in packages/graphql-api/src/models.ts:137

Type declaration:

• accessToken: Scalars["String"]

• refreshToken: Scalars["String"]

---

MutationResetPasswordArgs

Ƭ MutationResetPasswordArgs: object

Defined in packages/graphql-api/src/models.ts:93

Type declaration:

• newPassword: Scalars["String"]

• token: Scalars["String"]

---

MutationResolvers

Ƭ MutationResolvers: object

Defined in packages/graphql-api/src/models.ts:337

Type declaration:

• addEmail? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType, RequireFields‹MutationAddEmailArgs, "newEmail"››

• authenticate? : Resolver‹Maybe‹ResolversTypes["LoginResult"]›, ParentType, ContextType, RequireFields‹MutationAuthenticateArgs, "serviceName" | "params"››

• changePassword? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType, RequireFields‹MutationChangePasswordArgs, "oldPassword" | "newPassword"››

• createUser? : Resolver‹Maybe‹ResolversTypes["CreateUserResult"]›, ParentType, ContextType, RequireFields‹MutationCreateUserArgs, "user"››

• impersonate? : Resolver‹Maybe‹ResolversTypes["ImpersonateReturn"]›, ParentType, ContextType, RequireFields‹MutationImpersonateArgs, "accessToken" | "impersonated"››

• logout? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType›

• refreshTokens? : Resolver‹Maybe‹ResolversTypes["LoginResult"]›, ParentType, ContextType, RequireFields‹MutationRefreshTokensArgs, "accessToken" | "refreshToken"››

• resetPassword? : Resolver‹Maybe‹ResolversTypes["LoginResult"]›, ParentType, ContextType, RequireFields‹MutationResetPasswordArgs, "token" | "newPassword"››

• sendResetPasswordEmail? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType, RequireFields‹MutationSendResetPasswordEmailArgs, "email"››

• sendVerificationEmail? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType, RequireFields‹MutationSendVerificationEmailArgs, "email"››

• twoFactorSet? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType, RequireFields‹MutationTwoFactorSetArgs, "secret" | "code"››

• twoFactorUnset? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType, RequireFields‹MutationTwoFactorUnsetArgs, "code"››

• verifyAuthentication? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType, RequireFields‹MutationVerifyAuthenticationArgs, "serviceName" | "params"››

• verifyEmail? : Resolver‹Maybe‹ResolversTypes["Boolean"]›, ParentType, ContextType, RequireFields‹MutationVerifyEmailArgs, "token"››

---

MutationSendResetPasswordEmailArgs

Ƭ MutationSendResetPasswordEmailArgs: object

Defined in packages/graphql-api/src/models.ts:104

Type declaration:

• email: Scalars["String"]

---

MutationSendVerificationEmailArgs

Ƭ MutationSendVerificationEmailArgs: object

Defined in packages/graphql-api/src/models.ts:99

Type declaration:

• email: Scalars["String"]

---

MutationTwoFactorSetArgs

Ƭ MutationTwoFactorSetArgs: object

Defined in packages/graphql-api/src/models.ts:120

Type declaration:

• code: Scalars["String"]

• secret: TwoFactorSecretKeyInput

---

MutationTwoFactorUnsetArgs

Ƭ MutationTwoFactorUnsetArgs: object

Defined in packages/graphql-api/src/models.ts:126

Type declaration:

• code: Scalars["String"]

---

MutationVerifyAuthenticationArgs

Ƭ MutationVerifyAuthenticationArgs: object

Defined in packages/graphql-api/src/models.ts:149

Type declaration:

• params: AuthenticateParamsInput

• serviceName: Scalars["String"]

---

MutationVerifyEmailArgs

Ƭ MutationVerifyEmailArgs: object

Defined in packages/graphql-api/src/models.ts:88

Type declaration:

• token: Scalars["String"]

---

NextResolverFn

Ƭ NextResolverFn: function

Defined in packages/graphql-api/src/models.ts:255

Type declaration:

▸ (): Promise‹T›

---

Query

Ƭ Query: object

Defined in packages/graphql-api/src/models.ts:154

Type declaration:

• __typename? : "Query"

• getUser? : Maybe‹User›

• twoFactorSecret? : Maybe‹TwoFactorSecretKey›

---

QueryResolvers

Ƭ QueryResolvers: object

Defined in packages/graphql-api/src/models.ts:354

Type declaration:

• getUser? : Resolver‹Maybe‹ResolversTypes["User"]›, ParentType, ContextType›

• twoFactorSecret? : Resolver‹Maybe‹ResolversTypes["TwoFactorSecretKey"]›, ParentType, ContextType›

---

RequireFields

Ƭ RequireFields: object & object

Defined in packages/graphql-api/src/models.ts:5

---

Resolver

Ƭ Resolver: ResolverFn‹TResult, TParent, TContext, TArgs›

Defined in packages/graphql-api/src/models.ts:206

---

ResolverFn

Ƭ ResolverFn: function

Defined in packages/graphql-api/src/models.ts:208

Type declaration:

▸ (parent: TParent, args: TArgs, context: TContext, info: GraphQLResolveInfo): Promise‹TResult› | TResult

Parameters:

Name	Type
parent	TParent
args	TArgs
context	TContext
info	GraphQLResolveInfo

---

ResolverTypeWrapper

Ƭ ResolverTypeWrapper: Promise‹T› | T

Defined in packages/graphql-api/src/models.ts:204

---

Resolvers

Ƭ Resolvers: object

Defined in packages/graphql-api/src/models.ts:384

Type declaration:

• CreateUserResult? : CreateUserResultResolvers‹ContextType›

• EmailRecord? : EmailRecordResolvers‹ContextType›

• ImpersonateReturn? : ImpersonateReturnResolvers‹ContextType›

• LoginResult? : LoginResultResolvers‹ContextType›

• Mutation? : MutationResolvers‹ContextType›

• Query? : QueryResolvers‹ContextType›

• Tokens? : TokensResolvers‹ContextType›

• TwoFactorSecretKey? : TwoFactorSecretKeyResolvers‹ContextType›

• User? : UserResolvers‹ContextType›

---

ResolversParentTypes

Ƭ ResolversParentTypes: object

Defined in packages/graphql-api/src/models.ts:287

Mapping between all available schema types and the resolvers parents

Type declaration:

• AuthenticateParamsInput: AuthenticateParamsInput

• Boolean: Scalars["Boolean"]

• CreateUserInput: CreateUserInput

• CreateUserResult: CreateUserResult

• EmailRecord: EmailRecord

• ID: Scalars["ID"]

• ImpersonateReturn: ImpersonateReturn

• ImpersonationUserIdentityInput: ImpersonationUserIdentityInput

• LoginResult: LoginResult

• Mutation(): object

• Query(): object

• String: Scalars["String"]

• Tokens: Tokens

• TwoFactorSecretKey: TwoFactorSecretKey

• TwoFactorSecretKeyInput: TwoFactorSecretKeyInput

• User: User

• UserInput: UserInput

---

ResolversTypes

Ƭ ResolversTypes: object

Defined in packages/graphql-api/src/models.ts:266

Mapping between all available schema types and the resolvers types

Type declaration:

• AuthenticateParamsInput: AuthenticateParamsInput

• Boolean: ResolverTypeWrapper‹Scalars["Boolean"]›

• CreateUserInput: CreateUserInput

• CreateUserResult: ResolverTypeWrapper‹CreateUserResult›

• EmailRecord: ResolverTypeWrapper‹EmailRecord›

• ID: ResolverTypeWrapper‹Scalars["ID"]›

• ImpersonateReturn: ResolverTypeWrapper‹ImpersonateReturn›

• ImpersonationUserIdentityInput: ImpersonationUserIdentityInput

• LoginResult: ResolverTypeWrapper‹LoginResult›

• Mutation: ResolverTypeWrapper‹object›

• Query: ResolverTypeWrapper‹object›

• String: ResolverTypeWrapper‹Scalars["String"]›

• Tokens: ResolverTypeWrapper‹Tokens›

• TwoFactorSecretKey: ResolverTypeWrapper‹TwoFactorSecretKey›

• TwoFactorSecretKeyInput: TwoFactorSecretKeyInput

• User: ResolverTypeWrapper‹User›

• UserInput: UserInput

---

Scalars

Ƭ Scalars: object

Defined in packages/graphql-api/src/models.ts:8

All built-in and custom scalars, mapped to their actual values

Type declaration:

• Boolean: boolean

• Float: number

• ID: string

• Int: number

• String: string

---

SubscriptionObject

Ƭ SubscriptionObject: SubscriptionSubscriberObject‹TResult, TKey, TParent, TContext, TArgs› | SubscriptionResolverObject‹TResult, TParent, TContext, TArgs›

Defined in packages/graphql-api/src/models.ts:239

---

SubscriptionResolveFn

Ƭ SubscriptionResolveFn: function

Defined in packages/graphql-api/src/models.ts:222

Type declaration:

▸ (parent: TParent, args: TArgs, context: TContext, info: GraphQLResolveInfo): TResult | Promise‹TResult›

Parameters:

Name	Type
parent	TParent
args	TArgs
context	TContext
info	GraphQLResolveInfo

---

SubscriptionResolver

Ƭ SubscriptionResolver: function | SubscriptionObject‹TResult, TKey, TParent, TContext, TArgs›

Defined in packages/graphql-api/src/models.ts:243

---

SubscriptionSubscribeFn

Ƭ SubscriptionSubscribeFn: function

Defined in packages/graphql-api/src/models.ts:215

Type declaration:

▸ (parent: TParent, args: TArgs, context: TContext, info: GraphQLResolveInfo): AsyncIterator‹TResult› | Promise‹AsyncIterator‹TResult››

Parameters:

Name	Type
parent	TParent
args	TArgs
context	TContext
info	GraphQLResolveInfo

---

Tokens

Ƭ Tokens: object

Defined in packages/graphql-api/src/models.ts:160

Type declaration:

• __typename? : "Tokens"

• accessToken? : Maybe‹Scalars["String"]›

• refreshToken? : Maybe‹Scalars["String"]›

---

TokensResolvers

Ƭ TokensResolvers: object

Defined in packages/graphql-api/src/models.ts:359

Type declaration:

• __isTypeOf? : IsTypeOfResolverFn‹ParentType›

• accessToken? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• refreshToken? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

---

TwoFactorSecretKey

Ƭ TwoFactorSecretKey: object

Defined in packages/graphql-api/src/models.ts:166

Type declaration:

• __typename? : "TwoFactorSecretKey"

• ascii? : Maybe‹Scalars["String"]›

• base32? : Maybe‹Scalars["String"]›

• google_auth_qr? : Maybe‹Scalars["String"]›

• hex? : Maybe‹Scalars["String"]›

• otpauth_url? : Maybe‹Scalars["String"]›

• qr_code_ascii? : Maybe‹Scalars["String"]›

• qr_code_base32? : Maybe‹Scalars["String"]›

• qr_code_hex? : Maybe‹Scalars["String"]›

---

TwoFactorSecretKeyInput

Ƭ TwoFactorSecretKeyInput: object

Defined in packages/graphql-api/src/models.ts:178

Type declaration:

• ascii? : Maybe‹Scalars["String"]›

• base32? : Maybe‹Scalars["String"]›

• google_auth_qr? : Maybe‹Scalars["String"]›

• hex? : Maybe‹Scalars["String"]›

• otpauth_url? : Maybe‹Scalars["String"]›

• qr_code_ascii? : Maybe‹Scalars["String"]›

• qr_code_base32? : Maybe‹Scalars["String"]›

• qr_code_hex? : Maybe‹Scalars["String"]›

---

TwoFactorSecretKeyResolvers

Ƭ TwoFactorSecretKeyResolvers: object

Defined in packages/graphql-api/src/models.ts:365

Type declaration:

• __isTypeOf? : IsTypeOfResolverFn‹ParentType›

• ascii? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• base32? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• google_auth_qr? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• hex? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• otpauth_url? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• qr_code_ascii? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• qr_code_base32? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

• qr_code_hex? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

---

TypeResolveFn

Ƭ TypeResolveFn: function

Defined in packages/graphql-api/src/models.ts:247

Type declaration:

▸ (parent: TParent, context: TContext, info: GraphQLResolveInfo): Maybe‹TTypes› | Promise‹Maybe‹TTypes››

Parameters:

Name	Type
parent	TParent
context	TContext
info	GraphQLResolveInfo

---

User

Ƭ User: object

Defined in packages/graphql-api/src/models.ts:189

Type declaration:

• __typename? : "User"

• emails? : Maybe‹Array‹EmailRecord››

• id: Scalars["ID"]

• username? : Maybe‹Scalars["String"]›

---

UserInput

Ƭ UserInput: object

Defined in packages/graphql-api/src/models.ts:196

Type declaration:

• email? : Maybe‹Scalars["String"]›

• id? : Maybe‹Scalars["ID"]›

• username? : Maybe‹Scalars["String"]›

---

UserResolvers

Ƭ UserResolvers: object

Defined in packages/graphql-api/src/models.ts:377

Type declaration:

• __isTypeOf? : IsTypeOfResolverFn‹ParentType›

• emails? : Resolver‹Maybe‹Array‹ResolversTypes["EmailRecord"]››, ParentType, ContextType›

• id? : Resolver‹ResolversTypes["ID"], ParentType, ContextType›

• username? : Resolver‹Maybe‹ResolversTypes["String"]›, ParentType, ContextType›

Variables

Const AccountsModule

• AccountsModule: GraphQLModule‹AccountsModuleConfig, AccountsRequest, AccountsModuleContext› = new GraphQLModule<AccountsModuleConfig, AccountsRequest, AccountsModuleContext>({ name: 'accounts', typeDefs: ({ config }) => mergeTypeDefs( [ TypesTypeDefs, getQueryTypeDefs(config), getMutationTypeDefs(config), ...getSchemaDef(config), ], { useSchemaDefinition: config.withSchemaDefinition, } ), resolvers: ({ config }) => ({

[config.rootQueryName || 'Query']: Query,

[config.rootMutationName || 'Mutation']: Mutation,

User: UserResolvers,

} as any),

// If necessary, import AccountsPasswordModule together with this module imports: ({ config }) => [ CoreAccountsModule.forRoot({ userAsInterface: config.userAsInterface, }), ...(config.accountsServer.getServices().password ? [ AccountsPasswordModule.forRoot({ accountsPassword: config.accountsServer.getServices().password as AccountsPassword, ...config, }), ] : []), ], providers: ({ config }) => [ { provide: AccountsServer, useValue: config.accountsServer, }, ], context: context('accounts'), schemaDirectives: { auth: AuthenticatedDirective, }, configRequired: true, })

Defined in packages/graphql-api/src/modules/accounts/index.ts:45

---

Const AccountsPasswordModule

• AccountsPasswordModule: GraphQLModule‹AccountsPasswordModuleConfig, AccountsRequest› = new GraphQLModule<AccountsPasswordModuleConfig, AccountsRequest>({ name: 'accounts-password', typeDefs: ({ config }) => [TypesTypeDefs, getQueryTypeDefs(config), getMutationTypeDefs(config)], resolvers: ({ config }) => ({

[config.rootQueryName || 'Query']: Query,

[config.rootMutationName || 'Mutation']: Mutation,

} as any),

imports: ({ config }) => [ CoreAccountsModule.forRoot({ userAsInterface: config.userAsInterface, }), ], providers: ({ config }) => [ { provide: AccountsServer, useValue: config.accountsServer, }, { provide: AccountsPassword, useValue: config.accountsPassword, }, ], context: context('accounts-password'), configRequired: true, })

Defined in packages/graphql-api/src/modules/accounts-password/index.ts:25

---

Const CoreAccountsModule

• CoreAccountsModule: GraphQLModule‹CoreAccountsModuleConfig› = new GraphQLModule( { typeDefs: ({ config }) => makeSchema(config), resolvers: {}, imports: [], } )

Defined in packages/graphql-api/src/modules/core/index.ts:8

---

Const User

• User: object

Defined in packages/graphql-api/src/modules/accounts/resolvers/user.ts:1

Type declaration:

Functions

Const authenticated

▸ authenticated‹CustomRoot, CustomArgs, CustomContext, Info, ReturnType›(func: function): (Anonymous function)

Defined in packages/graphql-api/src/utils/authenticated-resolver.ts:1

Type parameters:

▪ CustomRoot

▪ CustomArgs

▪ CustomContext: object

▪ Info

▪ ReturnType

Parameters:

▪ func: function

▸ (root: CustomRoot, args: CustomArgs, context: CustomContext, info: Info): ReturnType | Promise‹ReturnType›

Parameters:

Name	Type
root	CustomRoot
args	CustomArgs
context	CustomContext
info	Info

Returns: (Anonymous function)

---

Const context

▸ context(moduleName: string): (Anonymous function)

Defined in packages/graphql-api/src/utils/context-builder.ts:5

Parameters:

Name	Type
moduleName	string

Returns: (Anonymous function)

Object literals

Const Mutation

▪ Mutation: object

Defined in packages/graphql-api/src/modules/accounts/resolvers/mutation.ts:6

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:13

addEmail

▸ addEmail(_: object, __namedParameters: object, __namedParameters: object): Promise‹any›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:14

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
newEmail	string

▪ __namedParameters: object

Name	Type
injector	Injector‹any›
user	User

Returns: Promise‹any›

authenticate

▸ authenticate(_: object, args: object & object, ctx: AccountsModuleContext‹User› & object): Promise‹LoginResult›

Defined in packages/graphql-api/src/modules/accounts/resolvers/mutation.ts:7

Parameters:

Name	Type
_	object
args	object & object
ctx	AccountsModuleContext‹User› & object

Returns: Promise‹LoginResult›

changePassword

▸ changePassword(_: object, __namedParameters: object, __namedParameters: object): Promise‹any›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:23

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
newPassword	string
oldPassword	string

▪ __namedParameters: object

Name	Type
injector	Injector‹any›
user	User

Returns: Promise‹any›

createUser

▸ createUser(_: object, __namedParameters: object, ctx: AccountsModuleContext‹User› & object): Promise‹object | object | object›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:32

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
user	object

▪ ctx: AccountsModuleContext‹User› & object

Returns: Promise‹object | object | object›

impersonate

▸ impersonate(_: object, args: object & object, ctx: AccountsModuleContext‹User› & object): Promise‹ImpersonationResult›

Defined in packages/graphql-api/src/modules/accounts/resolvers/mutation.ts:25

Parameters:

Name	Type
_	object
args	object & object
ctx	AccountsModuleContext‹User› & object

Returns: Promise‹ImpersonationResult›

logout

▸ logout(_: object, __: object, context: AccountsModuleContext‹User› & object): Promise‹any›

Defined in packages/graphql-api/src/modules/accounts/resolvers/mutation.ts:47

Parameters:

Name	Type
_	object
__	object
context	AccountsModuleContext‹User› & object

Returns: Promise‹any›

refreshTokens

▸ refreshTokens(_: object, args: object & object, ctx: AccountsModuleContext‹User› & object): Promise‹LoginResult›

Defined in packages/graphql-api/src/modules/accounts/resolvers/mutation.ts:56

Parameters:

Name	Type
_	object
args	object & object
ctx	AccountsModuleContext‹User› & object

Returns: Promise‹LoginResult›

resetPassword

▸ resetPassword(_: object, __namedParameters: object, __namedParameters: object): Promise‹LoginResult›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:97

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
newPassword	string
token	string

▪ __namedParameters: object

Name	Type
infos	ConnectionInformations
injector	Injector‹any›

Returns: Promise‹LoginResult›

sendResetPasswordEmail

▸ sendResetPasswordEmail(_: object, __namedParameters: object, __namedParameters: object): Promise‹any›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:100

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
email	string

▪ __namedParameters: object

Name	Type
injector	Injector‹any›

Returns: Promise‹any›

sendVerificationEmail

▸ sendVerificationEmail(_: object, __namedParameters: object, __namedParameters: object): Promise‹any›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:125

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
email	string

▪ __namedParameters: object

Name	Type
injector	Injector‹any›

Returns: Promise‹any›

twoFactorSet

▸ twoFactorSet(_: object, __namedParameters: object, __namedParameters: object): Promise‹any›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:75

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
code	string
secret	object

▪ __namedParameters: object

Name	Type
injector	Injector‹any›
user	User

Returns: Promise‹any›

twoFactorUnset

▸ twoFactorUnset(_: object, __namedParameters: object, __namedParameters: object): Promise‹any›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:86

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
code	string

▪ __namedParameters: object

Name	Type
injector	Injector‹any›
user	User

Returns: Promise‹any›

verifyAuthentication

▸ verifyAuthentication(_: object, args: object & object, ctx: AccountsModuleContext‹User› & object): Promise‹boolean›

Defined in packages/graphql-api/src/modules/accounts/resolvers/mutation.ts:16

Parameters:

Name	Type
_	object
args	object & object
ctx	AccountsModuleContext‹User› & object

Returns: Promise‹boolean›

verifyEmail

▸ verifyEmail(_: object, __namedParameters: object, __namedParameters: object): Promise‹any›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/mutation.ts:121

Parameters:

▪ _: object

▪ __namedParameters: object

Name	Type
token	string

▪ __namedParameters: object

Name	Type
injector	Injector‹any›

Returns: Promise‹any›

---

Const Query

▪ Query: object

Defined in packages/graphql-api/src/modules/accounts/resolvers/query.ts:5

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/query.ts:6

getUser

▸ getUser(_: object, __: object, context: AccountsModuleContext‹User› & object): User

Defined in packages/graphql-api/src/modules/accounts/resolvers/query.ts:6

Parameters:

Name	Type
_	object
__	object
context	AccountsModuleContext‹User› & object

Returns: User

twoFactorSecret

▸ twoFactorSecret(_: object, args: object, ctx: AccountsModuleContext‹User› & object): Promise‹Key›

Defined in packages/graphql-api/src/modules/accounts-password/resolvers/query.ts:7

Parameters:

Name	Type
_	object
args	object
ctx	AccountsModuleContext‹User› & object

Returns: Promise‹Key›