class PlaceOS::Client

Defined in:

placeos/client.cr

Constant Summary

API_ROOT = "/api/engine/v2"
AUTH_API_ROOT = "/auth"
VERSION = {{ (`shards version \"/srv/crystaldoc.info/github-PlaceOS-crystal-client-v2.11.11/src/placeos\"`).chomp.stringify.downcase }}

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(base_uri : URI | String, email : String | Nil = nil, password : String | Nil = nil, client_id : String | Nil = nil, client_secret : String | Nil = nil, token : OAuth2::AccessToken | Nil = nil, host_header : String | Nil = nil, insecure : Bool = false, x_api_key : String | Nil = nil) #

[View source]

Class Method Detail

def self.from_environment_user #

[View source]
def self.from_environment_user(&) #

[View source]
def self.tls_context : OpenSSL::SSL::Context::Client #

[View source]

Instance Method Detail

def api_wrapper : APIWrapper #

[View source]
def apikeys : APIWrapper::APIKeys #

Provide an object for managing APIKeys. See PlaceOS::Client::APIWrapper::APIKeys.


[View source]
def authenticated? #

[View source]
def authority : APIWrapper::Authority #

Provide an object for managing Authority. See PlaceOS::Client::APIWrapper::Authority.


[View source]
def close(*args, **options) #

[View source]
def close(*args, **options, &) #

[View source]
def cluster : APIWrapper::Cluster #

Provide an object for managing Cluster. See PlaceOS::Client::APIWrapper::Cluster.


[View source]
def domains : APIWrapper::Domains #

Provide an object for managing Domains. See PlaceOS::Client::APIWrapper::Domains.


[View source]
def drivers : APIWrapper::Drivers #

Provide an object for managing Drivers. See PlaceOS::Client::APIWrapper::Drivers.


[View source]
def ldap : APIWrapper::Ldap #

Provide an object for managing Ldap. See PlaceOS::Client::APIWrapper::Ldap.


[View source]
def metadata : APIWrapper::Metadata #

Provide an object for managing Metadata. See PlaceOS::Client::APIWrapper::Metadata.


[View source]
def modules : APIWrapper::Modules #

Provide an object for managing Modules. See PlaceOS::Client::APIWrapper::Modules.


[View source]
def oauth : APIWrapper::OAuth #

Provide an object for managing OAuth. See PlaceOS::Client::APIWrapper::OAuth.


[View source]
def oauthapplications : APIWrapper::OAuthApplications #

Provide an object for managing OAuthApplications. See PlaceOS::Client::APIWrapper::OAuthApplications.


[View source]
def root : APIWrapper::Root #

Provide an object for managing Root. See PlaceOS::Client::APIWrapper::Root.


[View source]
def saml : APIWrapper::Saml #

Provide an object for managing Saml. See PlaceOS::Client::APIWrapper::Saml.


[View source]
def settings : APIWrapper::Settings #

Provide an object for managing Settings. See PlaceOS::Client::APIWrapper::Settings.


[View source]
def systems : APIWrapper::Systems #

Provide an object for managing Systems. See PlaceOS::Client::APIWrapper::Systems.


[View source]
def uri : URI #

[View source]
def users : APIWrapper::Users #

Provide an object for managing Users. See PlaceOS::Client::APIWrapper::Users.


[View source]
def zones : APIWrapper::Zones #

Provide an object for managing Zones. See PlaceOS::Client::APIWrapper::Zones.


[View source]