logoutv1

Documentation

Overview

Package logoutv1 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 CallbackLogoutSuccessJSONBody
• type CallbackLogoutSuccessJSONRequestBody
• type ErrorResponse
• type LogoutCallback
• type LogoutRequest
• type Option
  • func WithTransport(transport http.RoundTripper) Option
• type Service
  • func NewService(oauth *clientcredentials.Config, options ...Option) Service
• type SessionId

Constants

const ParamRequest = "tiga_logout"

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

Variables

var Routes = route{}

Routes helps configure API endpoints.

Types

type CallbackLogoutSuccessJSONBody

type CallbackLogoutSuccessJSONBody LogoutCallback

CallbackLogoutSuccessJSONBody defines parameters for CallbackLogoutSuccess.

type CallbackLogoutSuccessJSONRequestBody

type CallbackLogoutSuccessJSONRequestBody CallbackLogoutSuccessJSONBody

CallbackLogoutSuccessJSONRequestBody defines body for CallbackLogoutSuccess for application/json ContentType.

type ErrorResponse

type ErrorResponse externalRef0.ErrorResponse

ErrorResponse defines model for ErrorResponse.

type LogoutCallback

type LogoutCallback struct {
	// True when user approved log out and has been loged out of the identity provider.
	LoggedOut bool `json:"logged_out,omitempty" yaml:"logged_out,omitempty"`
}

LogoutCallback defines model for LogoutCallback.

type LogoutRequest

type LogoutRequest struct {
	// 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"`

	// Session identifier previously provided by the identity provider.
	Sid string `json:"sid,omitempty" yaml:"sid,omitempty"`

	// Subject identifier of the authenticated user. The identity provider will attempt to terminate all sessions
	// associated with this subject if approved by user.
	Sub string `json:"sub,omitempty" yaml:"sub,omitempty"`

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

LogoutRequest defines model for LogoutRequest.

type Option

type Option func(s *defaultService)

func WithTransport

func WithTransport(transport http.RoundTripper) Option

type Service

type Service interface {
	// GetLogout retrieves the LogoutRequest with the url sent by Tiga on the Dyna logout entry point.
	GetLogout(ctx context.Context, url string) (*LogoutRequest, error)
	// ReplyLogout posts back the LogoutCallback result to Tiga.
	ReplyLogout(ctx context.Context, req *LogoutRequest, payload *LogoutCallback) error
}

Service abstracts the logout 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.