Interface PlaceAuthOptions

interface PlaceAuthOptions {
    auth_type?: "auth_code" | "implicit" | "password";
    auth_uri: string;
    client_secret?: string;
    delay?: number;
    entra_token?: () => Promise<string>;
    handle_login?: boolean;
    host?: string;
    ignore_api_key?: boolean;
    mock?: boolean;
    password?: string;
    redirect_uri: string;
    scope: string;
    secure?: boolean;
    storage?: "local" | "session";
    token_header?: boolean;
    token_uri: string;
    use_iframe?: boolean;
    username?: string;
    version?: "ACA Engine" | "PlaceOS";
}

Properties

auth_type? auth_uri client_secret? delay? entra_token? handle_login? host? ignore_api_key? mock? password? redirect_uri scope secure? storage? token_header? token_uri use_iframe? username? version?

Properties

Optionalauth_type

auth_type?: "auth_code" | "implicit" | "password"

auth_uri

auth_uri: string

URI for authorizing the user

Optionalclient_secret

client_secret?: string

Application secret

Optionaldelay

delay?: number

Delay authentication by X milliseconds

Optionalentra_token

entra_token?: () => Promise<string>

Get a Microsoft Entra access token for the user, e.g. Office.auth.getAccessToken. When set, authorise exchanges this token for PlaceOS tokens (RFC 8693) when no other credentials are available.

Optionalhandle_login

handle_login?: boolean

Whether service should handling user login. Defaults to true

Optionalhost

host?: string

Host name and port of the engine server

Optionalignore_api_key

ignore_api_key?: boolean

Whether X-API-KEY values should be ignored

Optionalmock

mock?: boolean

Whether system is in mock mode

Optionalpassword

password?: string

Password for the user being authorised

redirect_uri

redirect_uri: string

URI for handling authentication redirects. e.g. /assets/oauth-resp.html

scope

scope: string

Scope of the user permissions needed to access the application

Optionalsecure

secure?: boolean

Whether application uses TLS/SSL

Optionalstorage

storage?: "local" | "session"

Which keystore to use localStorage or sessionStorage. Defaults to `'local''

Optionaltoken_header

token_header?: boolean

Whether access tokens should be injected into request headers

token_uri

token_uri: string

URI for generating new tokens

Optionaluse_iframe

use_iframe?: boolean

Whether to perform authentication in an iframe

Optionalusername

username?: string

Username of the user to be authorised

Optionalversion

version?: "ACA Engine" | "PlaceOS"

Version of the API endpoints to use

Settings

Member Visibility

On This Page

Properties