struct PlaceOS::API::Models::Authority

• PlaceOS::API::Models::Authority
• Struct
• Value
• Object

Overview

Metadata about the PlaceOS instance connected to.

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

Included Modules

• JSON::Serializable

Defined in:

placeos/api/models/authority.cr

Constructors

• .new(pull : JSON::PullParser)

Instance Method Summary

• #config : Hash(String, JSON::Any)

  Additional configuration / context for clients.

• #description : String | Nil

  Authority description (markdown).

• #domain : String
• #id : String

  A universally unique identifier that represents the Authority.

• #login_url : String

  Path that clients should use for initiating authentication.

• #logout_url : String

  Path that clients should use for revoking authentication.

• #name : String

  Human readable name

• #production : Bool

  Flag for production status.

• #session : Bool

  Flag for if this client is currently authed.

Constructor Detail

Instance Method Detail