Interface PlaceAuthority

interface PlaceAuthority {
    config: HashMap;
    description: string;
    domain: string;
    email_domains?: string[];
    id: string;
    login_url: string;
    logout_url: string;
    metrics?: string;
    name: string;
    production: boolean;
    sentry_dsn?: string;
    session: boolean;
    version?: string;
}

Properties

config description domain email_domains? id login_url logout_url metrics? name production sentry_dsn? session version?

Properties

Readonlyconfig

config: HashMap

Configuration metadata for the authority

Readonlydescription

description: string

Description of the authority site

Readonlydomain

domain: string

Domain of the authority

Optional Readonlyemail_domains

email_domains?: string[]

List of email domains associated with the authority

Readonlyid

id: string

Place ID for the Authority

Readonlylogin_url

login_url: string

URL for user to login for authentication

Readonlylogout_url

logout_url: string

URL for user to clear authentication details

Optional Readonlymetrics

metrics?: string

URL to the metrics interface for Place

Readonlyname

name: string

Authority name

Readonlyproduction

production: boolean

Whether the engine instance is a production build

Optional Readonlysentry_dsn

sentry_dsn?: string

DSN for Sentry integration

Readonlysession

session: boolean

Whether the user has an authentication session

Optional Readonlyversion

version?: string

Version of the PlaceOS API

Settings

Member Visibility

On This Page

Properties