struct PlaceOS::Client::API::Models::OAuthAuthentication

Included Modules

Defined in:

placeos/api/models/auths/oauth.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

Constructor Detail

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

[View source]

Instance Method Detail

def auth_scheme : String #

If not set it defaults to "request_body", others include "basic_auth"


[View source]
def authority_id : String #

[View source]
def authorize_url : String #

The SSO providers URL for authorization, defaults to: oauth/authorize Google is /o/oauth2/auth


[View source]
def client_id : String #

The client ID and secret configured for this application


[View source]
def client_secret : String #

[View source]
def id : String #

[View source]
def info_mappings : Hash(String, String) #

Maps an expected key to a provided key i.e. {used_in_engine => used_by_remote}


[View source]
def name : String #

[View source]
def raw_info_url : String #

URL to call with a valid token to obtain the users profile data (name, email etc)


[View source]
def scope : String #

Space seperated scope strings i.e. https://www.googleapis.com/auth/devstorage.readonly https://www.googleapis.com/auth/prediction


[View source]
def site : String #

The HTTP URL of the SSO provider


[View source]
def token_method : String #

If not set it defaults to "post"


[View source]
def token_url : String #

defaults to: oauth/token however google is: /o/oauth2/token


[View source]