loginv1

Documentation

Overview

Package loginv1 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.8.3 DO NOT EDIT.

Index

• Constants
• Variables
• type AuthenticationCallback
• type AuthenticationRequest
• type CallbackAuthenticationFailureJSONBody
• type CallbackAuthenticationFailureJSONRequestBody
• type CallbackAuthenticationSuccessJSONBody
• type CallbackAuthenticationSuccessJSONRequestBody
• type ErrorResponse
• type Option
  • func WithTransport(transport http.RoundTripper) Option
• type Service
  • func NewService(oauth *clientcredentials.Config, options ...Option) Service
• type SessionId

Constants

const ParamRequest = "tiga_login"

ParamRequest is the name of the request parameter that contains the URL to fetch AuthenticationRequest.

Variables

var Routes = route{}

Routes helps configure API endpoints.

Types

type AuthenticationCallback

type AuthenticationCallback struct {
	// Authentication context class reference.
	Acr string `json:"acr,omitempty" yaml:"acr,omitempty"`

	// A list of authentication methods applied.
	Amr []string `json:"amr,omitempty" yaml:"amr,omitempty"`

	// Unix timestamp for time of authentication.
	AuthTime int64 `json:"auth_time,omitempty" yaml:"auth_time,omitempty"`

	// Identifier of the user session as a result of authentication.
	Sid string `json:"sid,omitempty" yaml:"sid,omitempty"`

	// Subject identifier of the authenticated user.
	Sub string `json:"sub,omitempty" yaml:"sub,omitempty"`
}

AuthenticationCallback defines model for AuthenticationCallback.

type AuthenticationRequest

type AuthenticationRequest struct {
	// Optional array of requested ACR values for the authentication.
	AcrValues []string `json:"acr_values,omitempty" yaml:"acr_values,omitempty"`

	// ClientInfo contains public client information that can be used to visually identity the client.
	Client externalRef0.ClientInfo `json:"client,omitempty" yaml:"client,omitempty"`
	Links  externalRef0.Links      `json:"links,omitempty" yaml:"links,omitempty"`

	// Optional login hint parameter to pass on to the identity provider.
	LoginHint string `json:"login_hint,omitempty" yaml:"login_hint,omitempty"`

	// Optional max_age parameter.
	MaxAge *int64 `json:"max_age,omitempty" yaml:"max_age,omitempty"`

	// Optional array containing prompt parameters.
	Prompts []string `json:"prompts,omitempty" yaml:"prompts,omitempty"`

	// Optional subject identifier to request authentication for.
	SubHint string `json:"sub_hint,omitempty" yaml:"sub_hint,omitempty"`

	// Optional list of preferred UI locales.
	UiLocales []string `json:"ui_locales,omitempty" yaml:"ui_locales,omitempty"`
}

AuthenticationRequest defines model for AuthenticationRequest.

type CallbackAuthenticationFailureJSONBody

type CallbackAuthenticationFailureJSONBody externalRef0.ErrorCallback

CallbackAuthenticationFailureJSONBody defines parameters for CallbackAuthenticationFailure.

type CallbackAuthenticationFailureJSONRequestBody

type CallbackAuthenticationFailureJSONRequestBody CallbackAuthenticationFailureJSONBody

CallbackAuthenticationFailureJSONRequestBody defines body for CallbackAuthenticationFailure for application/json ContentType.

type CallbackAuthenticationSuccessJSONBody

type CallbackAuthenticationSuccessJSONBody AuthenticationCallback

CallbackAuthenticationSuccessJSONBody defines parameters for CallbackAuthenticationSuccess.

type CallbackAuthenticationSuccessJSONRequestBody

type CallbackAuthenticationSuccessJSONRequestBody CallbackAuthenticationSuccessJSONBody

CallbackAuthenticationSuccessJSONRequestBody defines body for CallbackAuthenticationSuccess for application/json ContentType.

type ErrorResponse

type ErrorResponse externalRef0.ErrorResponse

ErrorResponse defines model for ErrorResponse.

type Option

type Option func(s *defaultService)

func WithTransport

func WithTransport(transport http.RoundTripper) Option

type Service

type Service interface {
	// GetAuthentication retrieves the AuthenticationRequest data from Tiga via a URL link provided on tiga during
	// the redirection to the Dyna login entrypoint.
	GetAuthentication(ctx context.Context, url string) (*AuthenticationRequest, error)
	// ReplyAuthenticationSuccess posts back the successful AuthenticationCallback to Tiga.
	ReplyAuthenticationSuccess(ctx context.Context, req *AuthenticationRequest, success *AuthenticationCallback) error
	// ReplyAuthenticationFailure posts back the failure ErrorCallback to Tiga.
	ReplyAuthenticationFailure(ctx context.Context, req *AuthenticationRequest, failure *commonv1.ErrorCallback) error
}

Service abstracts login API endpoints.

func NewService

func NewService(oauth *clientcredentials.Config, options ...Option) Service

NewService returns a new instance of the default implementation of Service.

type SessionId

type SessionId string

SessionId defines model for sessionId.