common

package
v1.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2024 License: MIT Imports: 0 Imported by: 0

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.0.0 DO NOT EDIT.

Index

Constants

View Source
const (
	ProjectIDScopes = "projectID.Scopes"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AdditionalPayload

type AdditionalPayload = string

AdditionalPayload Additional payload in JSON format

type AllTypes

type AllTypes struct {
	P1 *Paging `json:"p1,omitempty"`

	// P10 Timestamp of when the entity was deleted in yyyy-MM-dd'T'HH:mm:ss format
	P10 *Deleted `json:"p10,omitempty"`

	// P11 ID of the device
	P11 *DeviceID `json:"p11,omitempty"`

	// P12 Additional payload in JSON format
	P12 *AdditionalPayload `json:"p12,omitempty"`

	// P13 Generic status that can describe Corbado entities
	P13 *Status `json:"p13,omitempty"`

	// P14 ID of project
	P14 *ProjectID `json:"p14,omitempty"`

	// P15 Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side
	P15 *RequestID   `json:"p15,omitempty"`
	P16 *ErrorRsp    `json:"p16,omitempty"`
	P17 *AuthMethods `json:"p17,omitempty"`

	// P18 User entry with emails and phone numbers
	P18 *FullUser `json:"p18,omitempty"`

	// P19 Login Identifier type
	P19 *LoginIdentifierType `json:"p19,omitempty"`
	P2  *ClientInfo          `json:"p2,omitempty"`

	// P20 ID of the email OTP
	P20 *EmailCodeID `json:"p20,omitempty"`

	// P21 Application type
	P21 *AppType `json:"p21,omitempty"`

	// P22 What session management should be used
	P22 *SessionManagement `json:"p22,omitempty"`

	// P23 High entropy values from browser
	P23 *HighEntropyValues     `json:"p23,omitempty"`
	P24 *LoginIdentifierConfig `json:"p24,omitempty"`
	P25 *SocialProviderType    `json:"p25,omitempty"`

	// P3 generic ID
	P3 *ID `json:"p3,omitempty"`

	// P4 ID of the user
	P4 *UserID `json:"p4,omitempty"`

	// P5 ID of the email
	P5 *EmailID `json:"p5,omitempty"`

	// P6 ID of the email magic link
	P6 *EmailLinkID `json:"p6,omitempty"`

	// P7 ID of the phone number
	P7 *PhoneNumberID `json:"p7,omitempty"`

	// P8 Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format
	P8 *Created `json:"p8,omitempty"`

	// P9 Timestamp of when the entity was last updated in yyyy-MM-dd'T'HH:mm:ss format
	P9 *Updated `json:"p9,omitempty"`
}

AllTypes defines model for allTypes.

type AppType

type AppType string

AppType Application type

const (
	Empty  AppType = "empty"
	Native AppType = "native"
	Web    AppType = "web"
)

Defines values for AppType.

type AuthMethod

type AuthMethod string

AuthMethod Authentication methods

const (
	AuthMethodEmail       AuthMethod = "email"
	AuthMethodPassword    AuthMethod = "password"
	AuthMethodPhoneNumber AuthMethod = "phone_number"
	AuthMethodWebauthn    AuthMethod = "webauthn"
)

Defines values for AuthMethod.

type AuthMethods

type AuthMethods = []AuthMethod

AuthMethods defines model for authMethods.

type ClientInfo

type ClientInfo struct {
	// RemoteAddress client's IP address
	RemoteAddress string `json:"remoteAddress"`

	// UserAgent client's User Agent
	UserAgent string `json:"userAgent"`
}

ClientInfo defines model for clientInfo.

type Created

type Created = string

Created Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format

type Deleted

type Deleted = string

Deleted Timestamp of when the entity was deleted in yyyy-MM-dd'T'HH:mm:ss format

type DeviceID

type DeviceID = string

DeviceID ID of the device

type EmailCodeID

type EmailCodeID = string

EmailCodeID ID of the email OTP

type EmailID

type EmailID = string

EmailID ID of the email

type EmailLinkID

type EmailLinkID = string

EmailLinkID ID of the email magic link

type ErrorRsp

type ErrorRsp struct {
	Data  *map[string]interface{} `json:"data,omitempty"`
	Error struct {
		// Details Details of error
		Details *string `json:"details,omitempty"`

		// Links Additional links to help understand the error
		Links []string `json:"links"`

		// Type Type of error
		Type string `json:"type"`

		// Validation Validation errors per field
		Validation *[]struct {
			Field   string `json:"field"`
			Message string `json:"message"`
		} `json:"validation,omitempty"`
	} `json:"error"`

	// HttpStatusCode HTTP status code of operation
	HttpStatusCode int32  `json:"httpStatusCode"`
	Message        string `json:"message"`

	// RequestData Data about the request itself, can be used for debugging
	RequestData RequestData `json:"requestData"`

	// Runtime Runtime in seconds for this request
	Runtime float32 `json:"runtime"`
}

ErrorRsp defines model for errorRsp.

type Filter

type Filter = []string

Filter defines model for filter.

type FullUser

type FullUser struct {
	// ID ID of the user
	ID UserID `json:"ID"`

	// Created Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format
	Created        Created             `json:"created"`
	Emails         []UserEmail         `json:"emails"`
	FullName       string              `json:"fullName"`
	Name           string              `json:"name"`
	PhoneNumbers   []UserPhoneNumber   `json:"phoneNumbers"`
	SocialAccounts []UserSocialAccount `json:"socialAccounts"`

	// Status Generic status that can describe Corbado entities
	Status Status `json:"status"`

	// Updated Timestamp of when the entity was last updated in yyyy-MM-dd'T'HH:mm:ss format
	Updated   Updated        `json:"updated"`
	Usernames []UserUsername `json:"usernames"`
}

FullUser User entry with emails and phone numbers

type GenericRsp

type GenericRsp struct {
	// HttpStatusCode HTTP status code of operation
	HttpStatusCode int32  `json:"httpStatusCode"`
	Message        string `json:"message"`

	// RequestData Data about the request itself, can be used for debugging
	RequestData RequestData `json:"requestData"`

	// Runtime Runtime in seconds for this request
	Runtime float32 `json:"runtime"`
}

GenericRsp defines model for genericRsp.

type HighEntropyValues added in v1.0.5

type HighEntropyValues struct {
	// Mobile Mobile
	Mobile bool `json:"mobile"`

	// Platform Platform
	Platform string `json:"platform"`

	// PlatformVersion Platform version
	PlatformVersion string `json:"platformVersion"`
}

HighEntropyValues High entropy values from browser

type ID

type ID = string

ID generic ID

type LoginIdentifierConfig added in v1.0.5

type LoginIdentifierConfig struct {
	EnforceVerification LoginIdentifierConfigEnforceVerification `json:"enforceVerification"`
	Metadata            *map[string]interface{}                  `json:"metadata,omitempty"`

	// Type Login Identifier type
	Type                 LoginIdentifierType `json:"type"`
	UseAsLoginIdentifier bool                `json:"useAsLoginIdentifier"`
}

LoginIdentifierConfig defines model for loginIdentifierConfig.

type LoginIdentifierConfigEnforceVerification added in v1.0.5

type LoginIdentifierConfigEnforceVerification string

LoginIdentifierConfigEnforceVerification defines model for LoginIdentifierConfig.EnforceVerification.

Defines values for LoginIdentifierConfigEnforceVerification.

type LoginIdentifierType

type LoginIdentifierType string

LoginIdentifierType Login Identifier type

const (
	LoginIdentifierTypeCustom      LoginIdentifierType = "custom"
	LoginIdentifierTypeEmail       LoginIdentifierType = "email"
	LoginIdentifierTypePhoneNumber LoginIdentifierType = "phone_number"
)

Defines values for LoginIdentifierType.

type Page

type Page = int

Page defines model for page.

type PageSize

type PageSize = int

PageSize defines model for pageSize.

type Paging

type Paging struct {
	// Page current page returned in response
	Page int `json:"page"`

	// TotalItems total number of items available
	TotalItems int `json:"totalItems"`

	// TotalPages total number of pages available
	TotalPages int `json:"totalPages"`
}

Paging defines model for paging.

type PhoneNumberID

type PhoneNumberID = string

PhoneNumberID ID of the phone number

type ProjectID

type ProjectID = string

ProjectID ID of project

type RemoteAddress

type RemoteAddress = string

RemoteAddress defines model for remoteAddress.

type RequestData

type RequestData struct {
	// Link Link to dashboard with details about request
	Link string `json:"link"`

	// RequestID Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side
	RequestID RequestID `json:"requestID"`
}

RequestData Data about the request itself, can be used for debugging

type RequestID

type RequestID = string

RequestID Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side

type SessionID

type SessionID = string

SessionID defines model for sessionID.

type SessionManagement added in v1.0.5

type SessionManagement string

SessionManagement What session management should be used

const (
	SessionManagementCorbado SessionManagement = "SessionManagementCorbado"
	SessionManagementOwn     SessionManagement = "SessionManagementOwn"
)

Defines values for SessionManagement.

type SocialProviderType added in v1.0.5

type SocialProviderType string

SocialProviderType defines model for socialProviderType.

const (
	Github    SocialProviderType = "github"
	Google    SocialProviderType = "google"
	Microsoft SocialProviderType = "microsoft"
)

Defines values for SocialProviderType.

type Sort

type Sort = string

Sort defines model for sort.

type Status

type Status string

Status Generic status that can describe Corbado entities

const (
	StatusActive  Status = "active"
	StatusDeleted Status = "deleted"
	StatusPending Status = "pending"
)

Defines values for Status.

type UnusedParams

type UnusedParams struct {
	// RemoteAddress Client's remote address
	RemoteAddress *RemoteAddress `form:"remoteAddress,omitempty" json:"remoteAddress,omitempty"`

	// UserAgent Client's user agent
	UserAgent *UserAgent `form:"userAgent,omitempty" json:"userAgent,omitempty"`

	// Sort Field sorting
	Sort *Sort `form:"sort,omitempty" json:"sort,omitempty"`

	// Filter Field filtering
	Filter *Filter `form:"filter[],omitempty" json:"filter[],omitempty"`

	// Page Page number
	Page *Page `form:"page,omitempty" json:"page,omitempty"`

	// PageSize Number of items per page
	PageSize *PageSize `form:"pageSize,omitempty" json:"pageSize,omitempty"`
}

UnusedParams defines parameters for Unused.

type Updated

type Updated = string

Updated Timestamp of when the entity was last updated in yyyy-MM-dd'T'HH:mm:ss format

type UserAgent

type UserAgent = string

UserAgent defines model for userAgent.

type UserEmail

type UserEmail struct {
	// ID generic ID
	ID ID `json:"ID"`

	// Created Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format
	Created Created `json:"created"`
	Email   string  `json:"email"`

	// Status Generic status that can describe Corbado entities
	Status Status `json:"status"`

	// Updated Timestamp of when the entity was last updated in yyyy-MM-dd'T'HH:mm:ss format
	Updated Updated `json:"updated"`
}

UserEmail User's email

type UserID

type UserID = string

UserID ID of the user

type UserPhoneNumber

type UserPhoneNumber struct {
	// ID generic ID
	ID ID `json:"ID"`

	// Created Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format
	Created     Created `json:"created"`
	PhoneNumber string  `json:"phoneNumber"`

	// Status Generic status that can describe Corbado entities
	Status Status `json:"status"`

	// Updated Timestamp of when the entity was last updated in yyyy-MM-dd'T'HH:mm:ss format
	Updated Updated `json:"updated"`
}

UserPhoneNumber User's phone number

type UserSocialAccount added in v1.0.5

type UserSocialAccount struct {
	AvatarUrl       string             `json:"avatarUrl"`
	FullName        string             `json:"fullName"`
	IdentifierValue string             `json:"identifierValue"`
	ProviderType    SocialProviderType `json:"providerType"`
}

UserSocialAccount User's social account

type UserUsername added in v1.0.5

type UserUsername struct {
	// ID generic ID
	ID ID `json:"ID"`

	// Created Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format
	Created Created `json:"created"`

	// Status Generic status that can describe Corbado entities
	Status Status `json:"status"`

	// Updated Timestamp of when the entity was last updated in yyyy-MM-dd'T'HH:mm:ss format
	Updated  Updated `json:"updated"`
	Username string  `json:"username"`
}

UserUsername User's username

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL