Interface IConnection

A connection is the object describing the details of how a specific clients authenticates to a specific Environment.

Hierarchy

  • IConnection

Implemented by

Properties

allowNoBrowserConnection allowNoOriginConnection createdAt? domains enabled environment name origins token version

Properties

allowNoBrowserConnection

allowNoBrowserConnection: boolean

Decides if requests that are not originated from a browser are allowed.

allowNoOriginConnection

allowNoOriginConnection: boolean

Decides if requests that are missing the Origin header are allowed.

Optional createdAt

createdAt?: Date

Automatically generated date of when the given connection version was created at.

domains

domains: string[]

A list of domains that the client is allowed to send request to.

enabled

enabled: boolean

Is the connection enabled. If it is not, it wwill be ignored when creating a new bundle.

environment

environment: Environment

The environment this connection relates to.

name

name: string

The name of the clients this connection relates to.

origins

origins: string[]

A list of origins the client is allowed to send requests from.

token

token: string

The client's token for the specific environment. The KID parameter in the token should equal the client's name.

version

version: number

The version of the connection with the given name and environment. Starts at 1 and automatically increments. When updated, the POST body should contain the latest version.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc