Options
All
  • Public
  • Public/Protected
  • All
Menu

UserApiKeyAuthProviderClient

A client for creating, updating, and deleting the API keys of a Stitch user.

Index

Variables

Const factory

factory: AuthProviderClientFactory<UserApiKeyAuthProviderClient> = new classimplements AuthProviderClientFactory<UserApiKeyAuthProviderClient> {public getClient(authRequestClient: StitchAuthRequestClient,requestClient: StitchRequestClient, // This arg is ignoredroutes: StitchAuthRoutes): UserApiKeyAuthProviderClient {return new UserApiKeyAuthProviderClientImpl(authRequestClient, routes);}}()

Methods

createApiKey

  • createApiKey(name: string): Promise<UserApiKey>

deleteApiKey

  • deleteApiKey(keyId: BSON.ObjectID): Promise<void>

disableApiKey

  • disableApiKey(keyId: BSON.ObjectID): Promise<void>

enableApiKey

  • enableApiKey(keyId: BSON.ObjectID): Promise<void>

fetchApiKey

  • fetchApiKey(keyId: BSON.ObjectID): Promise<UserApiKey>

fetchApiKeys

  • fetchApiKeys(): Promise<UserApiKey[]>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc