MongoDB Stitch Browser SDK
Options
All
  • Public
  • Public/Protected
  • All
Menu

UserApiKeyCredential

A credential which can be used to log in as a Stitch user using the User API Key authentication provider.

Hierarchy

  • UserApiKeyCredential

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

key

key: string

The user API key contained within this credential.

material

material: object

The contents of this credential as they will be passed to the Stitch server.

Type declaration

  • [key: string]: string

providerCapabilities

providerCapabilities: ProviderCapabilities = new ProviderCapabilities(false)

The behavior of this credential when logging in.

providerName

providerName: string

The name of the provider for this credential.

providerType

providerType: string = UserApiKeyAuthProvider.TYPE

The type of the provider for this credential.

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