struct ACP::Protocol::AuthenticateParams

Overview

Params for the authenticate method (Client → Agent).

Included Modules

Defined in:

acp/protocol/types.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(method_id : String, credentials : JSON::Any | Nil = nil, meta : Hash(String, JSON::Any) | Nil = nil) #

[View source]

Instance Method Detail

def credentials : JSON::Any | Nil #

Optional credentials or token data, depending on the auth method.


[View source]
def credentials=(credentials : JSON::Any | Nil) #

Optional credentials or token data, depending on the auth method.


[View source]
def meta : Hash(String, JSON::Any) | Nil #

Extension metadata.


[View source]
def meta=(meta : Hash(String, JSON::Any) | Nil) #

Extension metadata.


[View source]
def method_id : String #

The authentication method ID to use (from the agent's authMethods list).


[View source]
def method_id=(method_id : String) #

The authentication method ID to use (from the agent's authMethods list).


[View source]