models

type AAGUID []byte

type AccountAccessReply struct {
	rout.Reply
	Allowed bool `json:"allowed"`
}

type AccountAccessRequest struct {
	ObjectID    string `json:"object_id" description:"The ID of the object to check access for" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	ObjectType  string `` /* 138-byte string literal not displayed */
	Relation    string `json:"relation" description:"The relation to check access for, e.g. can_view, can_edit" example:"can_view"`
	SubjectType string `json:"subject_type,omitempty" description:"The type of subject to check access for, e.g. service, user" example:"user"`
}

type AccountFeaturesReply struct {
	rout.Reply
	Features       []string `` /* 138-byte string literal not displayed */
	OrganizationID string   `json:"organization_id" description:"The ID of the organization the user has features in" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AccountFeaturesRequest struct {
	ID string `param:"id" description:"The ID of the organization to check roles for" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AccountRolesOrganizationReply struct {
	rout.Reply
	Roles          []string `json:"roles" description:"The roles the user has in the organization, e.g. can_view, can_edit"`
	OrganizationID string   `json:"organization_id" description:"The ID of the organization the user has roles in" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AccountRolesOrganizationRequest struct {
	ID string `param:"id" description:"The ID of the organization to check roles for" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AccountRolesReply struct {
	rout.Reply
	Roles []string `json:"roles"`
}

type AccountRolesRequest struct {
	ObjectID    string   `json:"object_id" description:"The ID of the object to check roles for" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	ObjectType  string   `` /* 137-byte string literal not displayed */
	SubjectType string   `json:"subject_type,omitempty" description:"The type of subject to check roles for, e.g. service, user" example:"user"`
	Relations   []string `json:"relations,omitempty" description:"The relations to check roles for, e.g. can_view, can_edit"`
}

type AcmeSolverRequest struct {
	Path string `param:"path" description:"The path to the acme challenge" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type Address struct {
	// Line1 is the first line of the address
	Line1 string `json:"line1"`
	// Line2 is the second line of the address
	Line2 string `json:"line2"`
	// City is the city of the address
	City string `json:"city"`
	// State is the state of the address
	State string `json:"state"`
	// PostalCode is the postal code of the address
	PostalCode string `json:"postalCode"`
	// Country is the country of the address
	Country string `json:"country"`
}

type AssessmentMethod struct {
	// ID is the unique identifier for the assessment method
	ID string `json:"id,omitempty"`
	// Type is the type of assessment being performed, e.g. Interview, Test, etc.
	Type string `json:"type,omitempty"`
	// Method is the associated language describing the assessment method
	Method string `json:"method,omitempty"`
}

type AssessmentObjective struct {
	// Class is the class of the assessment objective which is typically what framework it origins from
	Class string `json:"class,omitempty"`
	// ID is the unique identifier for the assessment objective
	ID string `json:"id,omitempty"`
	// Objective is the associated language describing the assessment objective
	Objective string `json:"objective,omitempty" `
}

type AuditLogOrderField string

type AuthData struct {
	AccessToken  string `json:"access_token" description:"The access token to be used for authentication"`
	RefreshToken string `json:"refresh_token,omitempty" description:"The refresh token to be used to refresh the access token after it expires"`
	Session      string `json:"session,omitempty" description:"The short-lived session token required for authentication"`
	TokenType    string `json:"token_type,omitempty" description:"The type of token being returned" example:"bearer"`
}

type AvailableAuthTypeLoginRequest struct {
	Username string `json:"username" description:"The email address associated with the existing account" example:"jsnow@example.com"`
}

type AvailableAuthTypeReply struct {
	rout.Reply
	Methods []enums.AuthProvider `json:"methods,omitempty"`
}

type Change struct {
	// FieldName is the name of the field that changed.
	FieldName string
	// Old is the old value of the field.
	Old any
	// New is the new value of the field.
	New any
}

type CreateTrustCenterAnonymousJWTResponse struct {
	AuthData
}

type Cron string

type DateTime time.Time

type Days []enums.JobWeekday

type DeleteIntegrationRequest struct {
	ID string `param:"id" description:"Integration ID" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type DeleteIntegrationResponse struct {
	rout.Reply
	Message string `json:"message"`
}

type EndImpersonationReply struct {
	rout.Reply
	Message string `json:"message" description:"Success message"`
}

type EndImpersonationRequest struct {
	SessionID string `json:"session_id" validate:"required" description:"The session ID to end"`
	Reason    string `json:"reason,omitempty" description:"Optional reason for ending the session"`
}

type ExampleCSVRequest struct {
	Filename string `json:"filename" description:"the file name to check for" example:"actionplan"`
}

type ExampleEvidence struct {
	// DocumentationType is the documentation artifact type for the example evidence
	DocumentationType string `json:"documentationType,omitempty"`
	// Description is the description of the example documentation artifact for the evidence
	Description string `json:"description,omitempty"`
}

type ExampleProvider interface {
	ExampleResponse() any
}

type File struct {
	ID           string    `json:"id,omitempty" description:"The ID of the uploaded file"`
	Name         string    `json:"name,omitempty" description:"The name of the uploaded file"`
	Size         int64     `json:"size,omitempty" description:"The size of the uploaded file in bytes"`
	MimeType     string    `json:"mime_type,omitempty" description:"The mime type of the uploaded file"`
	ContentType  string    `json:"content_type,omitempty" description:"The content type of the uploaded file"`
	PresignedURL string    `json:"presigned_url,omitempty" description:"The presigned URL to download the file"`
	MD5          []byte    `json:"md5,omitempty" description:"The MD5 hash of the uploaded file"`
	CreatedAt    time.Time `json:"created_at,omitempty" description:"The time the file was uploaded"`
	UpdatedAt    time.Time `json:"updated_at,omitempty" description:"The time the file was last updated"`
}

type ForgotPasswordReply struct {
	rout.Reply
	Message string `json:"message,omitempty"`
}

type ForgotPasswordRequest struct {
	Email string `` /* 136-byte string literal not displayed */
}

type GetIntegrationStatusRequest struct {
	Provider string `param:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
}

type GetIntegrationTokenRequest struct {
	Provider string `param:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
}

type ImplementationGuidance struct {
	// ReferenceID is the unique identifier for where the guidance was sourced from
	ReferenceID string `json:"referenceId,omitempty"`
	// Guidance are the steps to take to implement the control
	Guidance []string `json:"guidance,omitempty"`
}

type IntegrationStatusResponse struct {
	rout.Reply
	Provider     string `json:"provider"`
	Connected    bool   `json:"connected"`
	Status       string `json:"status,omitempty"` // "connected", "expired", "invalid"
	TokenValid   bool   `json:"tokenValid,omitempty"`
	TokenExpired bool   `json:"tokenExpired,omitempty"`
	Message      string `json:"message"`
	Integration  any    `json:"integration,omitempty"` // Will be *ent.Integration
}

type IntegrationToken struct {
	Provider         string     `json:"provider" description:"OAuth provider (github, slack, etc.)"`
	AccessToken      string     `json:"accessToken" description:"OAuth access token"`
	RefreshToken     string     `json:"refreshToken,omitempty" description:"OAuth refresh token"`
	ExpiresAt        *time.Time `json:"expiresAt,omitempty" description:"Token expiration time"`
	ProviderUserID   string     `json:"providerUserId,omitempty" description:"User ID from the OAuth provider"`
	ProviderUsername string     `json:"providerUsername,omitempty" description:"Username from the OAuth provider"`
	ProviderEmail    string     `json:"providerEmail,omitempty" description:"Email from the OAuth provider"`
}

type IntegrationTokenResponse struct {
	rout.Reply
	Provider  string            `json:"provider"`
	Token     *IntegrationToken `json:"token"`
	ExpiresAt *time.Time        `json:"expiresAt,omitempty"`
}

type InviteReply struct {
	rout.Reply
	ID          string `json:"user_id" description:"The ID of the user that was created" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	Email       string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	Message     string `json:"message"`
	JoinedOrgID string `json:"joined_org_id" description:"The ID of the organization the user joined" example:"01JJFVMGENQS9ZG3GVA50QVX5E"`
	Role        string `json:"role" description:"The role the user has in the organization" example:"admin"`
	AuthData
}

type InviteRequest struct {
	Token string `query:"token" description:"The token to be used to accept the invitation, token is sent via email"`
}

type JobCadence struct {
	Days      Days                      `json:"days,omitempty"`
	Time      string                    `json:"time,omitempty"`
	Frequency enums.JobCadenceFrequency `json:"frequency,omitempty"`
}

type JobConfiguration json.RawMessage

type JobRunnerRegistrationReply struct {
	Reply   rout.Reply
	Message string `json:"message"`
}

type JobRunnerRegistrationRequest struct {
	IPAddress string   `json:"ip_address" description:"The IP address of the node being registered"`
	Token     string   `json:"token" description:"Your agent registration token"`
	Name      string   `json:"name" description:"the name of your job runner node"`
	Tags      []string `json:"tags" description:"The tags for your runner node"`
}

type ListIntegrationsResponse struct {
	rout.Reply
	Integrations any `json:"integrations"` // Will be []*ent.Integration
}

type LoginReply struct {
	rout.Reply
	AuthData
	TFAEnabled bool   `json:"tfa_enabled,omitempty"`
	Message    string `json:"message"`
}

type LoginRequest struct {
	Username string `json:"username" description:"The email address associated with the existing account" example:"jsnow@example.com"`
	Password string `json:"password" description:"The password associated with the account" example:"Wint3rIsC0ming123!"`
}

type OAuthCallbackRequest struct {
	Provider string `json:"provider,omitempty" query:"provider" description:"OAuth provider (extracted from state)"`
	Code     string `json:"code" query:"code" description:"OAuth authorization code"`
	State    string `json:"state" query:"state" description:"OAuth state parameter"`
}

type OAuthCallbackResponse struct {
	rout.Reply
	Success     bool   `json:"success" description:"Whether the OAuth callback was processed successfully"`
	Integration any    `json:"integration,omitempty" description:"The created/updated integration object"`
	Message     string `json:"message" description:"Success or error message" example:"Successfully connected GitHub integration"`
}

type OAuthFlowRequest struct {
	Provider    string   `json:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
	RedirectURI string   ``                                                                         /* 126-byte string literal not displayed */
	Scopes      []string `json:"scopes,omitempty" description:"Additional OAuth scopes to request"` // example: ["repo", "gist"]
}

type OAuthFlowResponse struct {
	rout.Reply
	AuthURL       string `` /* 141-byte string literal not displayed */
	State         string `json:"state,omitempty" description:"OAuth state parameter for security" example:"eyJvcmdJRCI6IjAxSE..."`
	Message       string `` /* 146-byte string literal not displayed */
	RequiresLogin bool   `json:"requiresLogin,omitempty" description:"Whether user needs to login before OAuth flow"`
}

type OauthTokenRequest struct {
	Name             string `json:"name" description:"The name of the user" example:"Jon Snow"`
	Email            string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	AuthProvider     string `json:"authProvider" description:"The provider used to authenticate the user, e.g. google, github, etc." example:"google"`
	ExternalUserID   string `json:"externalUserId" description:"The ID of the user from the external provider" example:"1234567890"`
	ExternalUserName string `json:"externalUserName" description:"The username of the user from the external provider" example:"jsnow"`
	ClientToken      string `json:"clientToken" description:"The token provided by the external provider"`
	Image            string `json:"image,omitempty" description:"The image URL of the user from the external provider"`
}

type OrgModule string

type Price struct {
	// Amount is the dollar amount of the price (e.g 100)
	Amount float64 `json:"amount"`
	// Interval is the interval of the price (e.g monthly, yearly)
	Interval string `json:"interval"`
	// Currency is the currency of the price that is being charged (e.g USD)
	Currency string `json:"currency"`
}

type Reference struct {
	// Name is the name of the reference
	Name string `json:"name,omitempty"`
	// URL is the link to the reference
	URL string `json:"url,omitempty"`
}

type RefreshIntegrationTokenRequest struct {
	Provider string `param:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
}

type RefreshReply struct {
	rout.Reply
	Message string `json:"message,omitempty"`
	AuthData
}

type RefreshRequest struct {
	RefreshToken string `json:"refresh_token" description:"The token to be used to refresh the access token after expiration"`
}

type RegisterReply struct {
	rout.Reply
	ID      string `json:"user_id" description:"The ID of the user that was created" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	Email   string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	Message string `json:"message"`
	Token   string `json:"token,omitempty" exclude:"true"` // only used for requests against local development, excluded from OpenAPI documentation
}

type RegisterRequest struct {
	FirstName string  `json:"first_name,omitempty" description:"The first name of the user" example:"Jon"`
	LastName  string  `json:"last_name,omitempty" description:"The last name of the user" example:"Snow"`
	Email     string  `json:"email,omitempty" description:"The email address of the user" example:"jsnow@example.com"`
	Password  string  `` /* 130-byte string literal not displayed */
	Token     *string `` /* 126-byte string literal not displayed */
}

type ResendReply struct {
	rout.Reply
	Message string `json:"message"`
}

type ResendRequest struct {
	Email string `` /* 134-byte string literal not displayed */
}

type ResetPasswordReply struct {
	rout.Reply
	Message string `json:"message"`
}

type ResetPasswordRequest struct {
	Password string `json:"password" description:"The new password to be used for authentication"`
	Token    string `json:"token" description:"The token to be used to reset the password, token is sent via email"`
}

type SSOAuthorizationMap map[string]time.Time

type SSOCallbackRequest struct {
	Code           string `json:"code" query:"code" description:"authorization code" example:"abc"`
	State          string `json:"state" query:"state" description:"state value" example:"state123"`
	OrganizationID string `json:"organization_id" query:"organization_id" description:"organization id" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
}

type SSOLoginRequest struct {
	OrganizationID string `json:"organization_id" query:"organization_id" description:"organization id" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	ReturnURL      string `json:"return" query:"return" description:"return url after authentication" example:"https://app.mitb.com"`
}

type SSOStatusReply struct {
	rout.Reply
	Enforced       bool              `json:"enforced"`
	Provider       enums.SSOProvider `json:"provider,omitempty"`
	DiscoveryURL   string            `json:"discovery_url,omitempty"`
	OrganizationID string            `json:"organization_id,omitempty"`
}

type SSOStatusRequest struct {
	Resource string `query:"resource" description:"organization or user email to check" example:"org:01J4EXD5MM60CX4YNYN0DEE3Y1"`
}

type SSOTokenAuthorizeReply struct {
	rout.Reply
	OrganizationID string `json:"organization_id"`
	TokenID        string `json:"token_id"`
	Message        string `json:"message,omitempty"`
}

type SSOTokenAuthorizeRequest struct {
	OrganizationID string `json:"organization_id" query:"organization_id" description:"organization id" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	TokenID        string `json:"token_id" query:"token_id" description:"token id to authorize" example:"01JJFVMGENQS9ZG3GVA50QVX5E"`
	TokenType      string `json:"token_type" query:"token_type" description:"token type: api or personal" example:"api"`
}

type SSOTokenCallbackRequest struct {
	Code  string `json:"code" query:"code" description:"authorization code" example:"abc"`
	State string `json:"state" query:"state" description:"state value" example:"state123"`
}

type SemverVersion struct {
	// Major is the major version
	Major int `json:"major,omitempty"`
	// Minor is the minor version
	Minor int `json:"minor,omitempty"`
	// Patch is the patch version
	Patch int `json:"patch,omitempty"`
	// PreRelease is the pre-release version (used for draft versions)
	PreRelease string `json:"preRelease,omitempty"`
}

type StartImpersonationReply struct {
	rout.Reply
	Token     string    `json:"token" description:"The impersonation token"`
	ExpiresAt time.Time `json:"expires_at" description:"When the impersonation token expires"`
	SessionID string    `json:"session_id" description:"The impersonation session ID"`
	Message   string    `json:"message" description:"Success message"`
}

type StartImpersonationRequest struct {
	TargetUserID   string   `json:"target_user_id" validate:"required" description:"The ID of the user to impersonate"`
	Type           string   `json:"type" validate:"required,oneof=support job admin" description:"The type of impersonation (support, job, admin)"`
	Reason         string   `json:"reason" validate:"required,min=10,max=500" description:"Reason for the impersonation"`
	Duration       *int     `json:"duration_hours,omitempty" description:"Duration in hours (optional, defaults to 1 hour)"`
	Scopes         []string `json:"scopes,omitempty" description:"Specific scopes for the impersonation session"`
	OrganizationID string   `json:"organization_id,omitempty" description:"Organization context for impersonation"`
}

type SwitchOrganizationReply struct {
	rout.Reply
	AuthData
}

type SwitchOrganizationRequest struct {
	TargetOrganizationID string `json:"target_organization_id" description:"The ID of the organization to switch to" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
}

type TFAReply struct {
	rout.Reply
	Message string `json:"message"`
}

type TFARequest struct {
	TOTPCode     string `` /* 127-byte string literal not displayed */
	RecoveryCode string `` /* 133-byte string literal not displayed */
}

type UploadFilesReply struct {
	rout.Reply
	Message   string `json:"message,omitempty"`
	FileCount int64  `json:"file_count,omitempty" description:"The number of files uploaded"`
	Files     []File `json:"files,omitempty" description:"The files that were uploaded"`
}

type UploadFilesRequest struct {
	UploadFile multipart.FileHeader `form:"uploadFile" description:"The file to be uploaded"`
}

type UserInfoReply struct {
	rout.Reply
	ID              string  `json:"id" description:"The ID of the user" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	Email           string  `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	FirstName       string  `json:"first_name,omitempty" description:"The first name of the user" example:"Jon"`
	LastName        string  `json:"last_name,omitempty" description:"The last name of the user" example:"Snow"`
	DisplayName     string  `json:"display_name,omitempty" description:"The display name of the user" example:"Jon Snow"`
	AvatarRemoteURL *string `json:"avatar_remote_url,omitempty" description:"URL of the user's remote avatar" example:"https://example.com/avatar.jpg"`
	LastSeen        *string `json:"last_seen,omitempty" description:"The time the user was last seen" example:"2023-01-01T00:00:00Z"`
	Role            string  `json:"role,omitempty" description:"The user's role" example:"ADMIN"`
	Sub             string  `json:"sub" description:"The subject of the user JWT" example:"user123"`
}

type VerifyReply struct {
	rout.Reply
	ID      string `json:"user_id" description:"The ID of the user that was created" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	Email   string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	Message string `json:"message,omitempty"`
	AuthData
}

type VerifyRequest struct {
	Token string `query:"token" description:"The token to be used to verify the email address, token is sent via email"`
}

type VerifySubscribeReply struct {
	rout.Reply
	Message string `json:"message,omitempty"`
}

type VerifySubscribeRequest struct {
	Token string `query:"token" description:"The token to be used to verify the subscription, token is sent via email"`
}

type VersionBump string

type WebauthnBeginLoginResponse struct {
	Reply rout.Reply
	*protocol.CredentialAssertion
	Session string `json:"session,omitempty"`
}

type WebauthnBeginRegistrationResponse struct {
	Reply rout.Reply
	*protocol.CredentialCreation
	Session string `json:"session,omitempty"`
}

type WebauthnLoginFinishRequest struct {
	ID                      string                 `json:"id" description:"The credential ID"`
	RawID                   string                 `json:"rawId" description:"The raw credential ID"`
	Type                    string                 `json:"type" description:"The credential type, should be 'public-key'"`
	AuthenticatorAttachment string                 `json:"authenticatorAttachment,omitempty" description:"How the authenticator is attached"`
	ClientExtensionResults  map[string]interface{} `json:"clientExtensionResults,omitempty" description:"Extension results"`
	Response                struct {
		AuthenticatorData string `json:"authenticatorData" description:"The authenticator data"`
		ClientDataJSON    string `json:"clientDataJSON" description:"The client data JSON"`
		Signature         string `json:"signature" description:"The assertion signature"`
		UserHandle        string `json:"userHandle,omitempty" description:"The user handle"`
	} `json:"response" description:"The authenticator response"`
}

type WebauthnLoginRequest struct {
	Email string `json:"email,omitempty" description:"The email address associated with the account" example:"jsnow@example.com"`
}

type WebauthnLoginResponse struct {
	rout.Reply
	Message string `json:"message,omitempty"`
	AuthData
}

type WebauthnRegistrationFinishRequest struct {
	ID                      string                 `json:"id" description:"The credential ID"`
	RawID                   string                 `json:"rawId" description:"The raw credential ID"`
	Type                    string                 `json:"type" description:"The credential type, should be 'public-key'"`
	AuthenticatorAttachment string                 `json:"authenticatorAttachment,omitempty" description:"How the authenticator is attached"`
	ClientExtensionResults  map[string]interface{} `json:"clientExtensionResults,omitempty" description:"Extension results"`
	Response                struct {
		AttestationObject  string   `json:"attestationObject" description:"The attestation object"`
		ClientDataJSON     string   `json:"clientDataJSON" description:"The client data JSON"`
		PublicKey          string   `json:"publicKey,omitempty" description:"The public key"`
		PublicKeyAlgorithm int      `json:"publicKeyAlgorithm,omitempty" description:"The public key algorithm"`
		Transports         []string `json:"transports,omitempty" description:"Available transports"`
		AuthenticatorData  string   `json:"authenticatorData,omitempty" description:"The authenticator data"`
	} `json:"response" description:"The authenticator response"`
}

type WebauthnRegistrationRequest struct {
	Email string `json:"email" description:"The email address associated with the account" example:"jsnow@example.com"`
	Name  string `json:"name,omitempty" description:"The name of the user" example:"Jon Snow"`
}

type WebauthnRegistrationResponse struct {
	rout.Reply
	Message string `json:"message,omitempty"`
	AuthData
}

type WebfingerRequest struct {
	Resource string `query:"resource" description:"resource identifier prefixed with org: or acct:" example:"acct:meowmeow@kitties.com"`
}