struct

PlaceOS::API::Models::Authority

Inherits JSON::Serializable < Struct < Value < Object

Metadata about the PlaceOS instance connected to.

This provides information that may be of relevance for authentication or providing client-side configuration information.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

config

Additional configuration / context for clients.

Source
description

Authority description (markdown).

Source
domain

FQDN or IP address this authority serves.

Source
id

A universally unique identifier that represents the Authority.

Source
login_url

Path that clients should use for initiating authentication.

Source
logout_url

Path that clients should use for revoking authentication.

Source
name

Human readable name

Source
production

Flag for production status.

Source
session

Flag for if this client is currently authed.

Source