struct PlaceOS::Client::API::Models::APIKey

Included Modules

Defined in:

placeos/api/models/api_key.cr

Constructors

Instance Method Summary

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

created_at : Time created_at, updated_at : Time updated_at

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

new(pull : JSON::PullParser) new

Macros inherited from module PlaceOS::Client::API::Models::Response::Init

__add_initialize__ __add_initialize__

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def authority : Authority #

[View source]
def authority_id : String #

[View source]
def description : String | Nil #

Markdown formatted text that describes the zone.


[View source]
def id : String #

A universally unique identifier for the zone.


[View source]
def name : String #

A human readable identifier.


[View source]
def permissions : PlaceOS::Model::UserJWT::Permissions #

The permission level of the user


[View source]
def scopes : Array(String) #

API scopes


[View source]
def user : User #

[View source]
def user_id : String #

[View source]
def x_api_key : String #

The auth key, only returned on create


[View source]