Struct ConfigRequest

pub struct ConfigRequest {
    pub authenticated_username: Option<String>,
    pub client_version: Option<String>,
    pub connection_id: String,
    pub environment: Option<HashMap<String, MetadataValue>>,
    pub files: Option<HashMap<String, BinaryMetadataValue>>,
    pub metadata: Option<HashMap<String, MetadataValue>>,
    pub remote_address: String,
    pub username: String,
}

Fields

authenticated_username: Option<String>

AuthenticatedUsername contains the username that was actually verified. This may differ from LoginUsername when, for example OAuth2 or Kerberos authentication is used. This field is empty until the authentication phase is completed.

client_version: Option<String>

ClientVersion contains the version string the connecting client sent if any. May be empty if the client did not provide a client version.

connection_id: String

ConnectionID is an opaque ID to identify the SSH connection in question.

environment: Option<HashMap<String, MetadataValue>>

Environment is a set of key-value pairs provided by the authentication or configuration system and may be exposed by the backend.

files: Option<HashMap<String, BinaryMetadataValue>>

Files is a key-value pair of file names and their content set by the authentication or configuration system and consumed by the backend.

metadata: Option<HashMap<String, MetadataValue>>

Metadata is a set of key-value pairs that carry additional information from the authentication and configuration system to the backends. Backends can expose this information as container labels, environment variables, or other places.

remote_address: String

RemoteAddress is the IP address and port of the user trying to authenticate.

username: String

Username is the username provided on login by the client. This may, but must not necessarily match the authenticated username.

Implementations

impl ConfigRequest

pub fn new( connection_id: String, remote_address: String, username: String, ) -> ConfigRequest

Trait Implementations

impl Clone for ConfigRequest

fn clone(&self) -> ConfigRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for ConfigRequest

Converts Query Parameters representation (style=form, explode=false) to a ConfigRequest value as specified in https://swagger.io/docs/specification/serialization/ Should be implemented in a serde deserializer

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for ConfigRequest

fn eq(&self, other: &ConfigRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConfigRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToString for ConfigRequest

Converts the ConfigRequest value to the Query Parameters representation (style=form, explode=false) specified in https://swagger.io/docs/specification/serialization/ Should be implemented in a serde serializer

fn to_string(&self) -> String

Converts the given value to a String.

impl Validate for ConfigRequest

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for ConfigRequest

type Args = ()

fn validate_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl StructuralPartialEq for ConfigRequest