types

Documentation

Index

• type WebhookAuthRequest
• type WebhookKeyboardInteractiveAuthRequest
• type WebhookKeyboardInteractiveResponse
• type WebhookPasswordAuthRequest
• type WebhookPublicKeyAuthRequest

Types

type WebhookAuthRequest

type WebhookAuthRequest struct {
	Username string `json:"username"`
	AuthType string `json:"auth_type"` // "password", "public_key", or "keyboard_interactive"
}

WebhookAuthRequest is the shared base JSON body sent to webhook endpoints.

type WebhookKeyboardInteractiveAuthRequest

type WebhookKeyboardInteractiveAuthRequest struct {
	WebhookAuthRequest
	SessionID      string   `json:"session_id"`
	ChallengeRound int      `json:"challenge_round"`
	Answers        []string `json:"answers,omitempty"`
}

WebhookKeyboardInteractiveAuthRequest is sent for keyboard-interactive authentication challenge rounds.

type WebhookKeyboardInteractiveResponse

type WebhookKeyboardInteractiveResponse struct {
	Name        string   `json:"name,omitempty"`
	Instruction string   `json:"instruction,omitempty"`
	Questions   []string `json:"questions"`
	Echos       []bool   `json:"echos,omitempty"`
}

WebhookKeyboardInteractiveResponse describes the next challenge round that should be presented to the SSH client. A 202 response should include this payload, while 200 means authentication succeeded and 401 means denied.

type WebhookPasswordAuthRequest

type WebhookPasswordAuthRequest struct {
	WebhookAuthRequest
	Password string `json:"password"`
}

WebhookPasswordAuthRequest is sent for password authentication.

type WebhookPublicKeyAuthRequest

type WebhookPublicKeyAuthRequest struct {
	WebhookAuthRequest
	PublicKey string `json:"public_key"`
}

WebhookPublicKeyAuthRequest is sent for public key authentication.