auth

Documentation

Index

• type AuthorizationRequest
• type PasswordAuthRequest
• type PublicKey
• type PublicKeyAuthRequest
• type Response
• type ResponseBody

Types

type AuthorizationRequest

type AuthorizationRequest struct {
	metadata.ConnectionAuthenticatedMetadata `json:",inline"`
}

AuthorizationRequest is the authorization request used after some authentication methods (e.g. kerberos) to determine whether users are allowed to access the service

swagger:model AuthorizationRequest

type PasswordAuthRequest

type PasswordAuthRequest struct {
	metadata.ConnectionAuthPendingMetadata `json:",inline"`

	// Password the user provided for authentication.
	//
	// required: true
	// swagger:strfmt Base64
	Password string `json:"passwordBase64"`
}

PasswordAuthRequest is an authentication request for password authentication.

swagger:model PasswordAuthRequest

type PublicKey

type PublicKey struct {
	// PublicKey is the key in the authorized key format.
	//
	// required: true
	PublicKey string `json:"publicKey"`
}

PublicKey contains the details of a public key provided during authentication.

type PublicKeyAuthRequest

type PublicKeyAuthRequest struct {
	metadata.ConnectionAuthPendingMetadata `json:",inline"`

	PublicKey `json:",inline"`
}

PublicKeyAuthRequest is an authentication request for public key authentication.

swagger:model PublicKeyAuthRequest

type Response

type Response struct {
	// The response body
	//
	// in: body
	ResponseBody
}

Response is the full HTTP authentication response.

swagger:response AuthResponse

type ResponseBody

type ResponseBody struct {
	metadata.ConnectionAuthenticatedMetadata `json:",inline"`

	// Success indicates if the authentication was successful.
	//
	// required: true
	// in: body
	Success bool `json:"success"`
}

ResponseBody is a response to authentication requests.

swagger:model AuthResponseBody