openapi

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

type AccountAccessResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Allowed is the allowed value.
	Allowed bool `json:"allowed"`
}

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

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

type AccountRolesMeRequest struct{}

type AccountRolesMeResponse struct {
	rout.Reply
	Roles          []OrganizationRole `json:"roles" description:"Organization responsibility roles assigned to the authenticated caller"`
	OrganizationID string             `json:"organization_id" description:"The ID of the organization the roles apply to" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

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

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

type AccountRolesRequest struct {
	// @deprecated use ObjectIDs instead, may be removed in a future release
	ObjectID string `` /* 153-byte string literal not displayed */
	// ObjectIDs is the object_ids value.
	ObjectIDs []string `` // example:"["01J4EXD5MM60CX4YNYN0DEE3Y1", "01J4EXD5MM60CX4YNYN0DEE3Y2"]"
	/* 132-byte string literal not displayed */
	// ObjectType is the object_type value.
	ObjectType string `` /* 137-byte string literal not displayed */
	// SubjectType is the subject_type value.
	SubjectType string `json:"subject_type,omitempty" description:"The type of subject to check roles for, e.g. service, user" example:"user"`
	// Relations is the relations value.
	Relations []string `json:"relations,omitempty" description:"The relations to check roles for, e.g. can_view, can_edit"`
}

type AccountRolesResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Roles is a list of roles the user has for the specified object(s)
	// @deprecated use ObjectRoles instead, may be removed in a future release
	Roles []string `json:"roles" description:" @deprecated use ObjectRoles instead. A list of roles the subject has for the specified object"`
	// ObjectRoles is a map of object IDs to the roles the user has for each object ID
	ObjectRoles map[string][]string `json:"object_roles,omitempty" description:"A map of object IDs to the roles the subject has for each object ID"`
}

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

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

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

type AvailableAuthTypeResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Methods is the methods value.
	Methods []enums.AuthProvider `json:"methods,omitempty"`
}

type ConfigureIntegrationRequest struct {
	// DefinitionID is the canonical integration definition ID from the path.
	DefinitionID string `param:"definitionID" description:"Integration definition ID" example:"def_01K0GCPSCC00000000000000001"`
	// IntegrationID is the optional existing installation to update credentials on; when omitted we create a new integration.
	IntegrationID string `json:"integrationId,omitempty"`
	// CredentialRef selects which credential slot is being configured.
	CredentialRef string `json:"credentialRef"`
	// Body holds the provider-specific credential fields as a raw JSON object.
	Body json.RawMessage `json:"body"`
	// UserInput holds optional installation-scoped provider configuration.
	UserInput json.RawMessage `json:"userInput,omitempty"`
}

type ConfigureIntegrationResponse struct {
	rout.Reply
	// Provider is the configured definition ID.
	Provider string `json:"provider"`
	// IntegrationID is the installation record ID that was created or updated.
	IntegrationID string `json:"integrationId"`
	// HealthStatus is the result of the inline validation health check.
	HealthStatus string `json:"healthStatus,omitempty"`
	// HealthSummary is a human-readable description of the health check result.
	HealthSummary string `json:"healthSummary,omitempty"`
	// InstallationMetadata is the provider-specific installation identity metadata resolved during configuration (e.g. Slack team name, GitHub org, AWS account).
	InstallationMetadata json.RawMessage `json:"installationMetadata,omitempty"`
	// WebhookEndpointURL is the user-facing webhook or SCIM endpoint URL when the definition declares webhooks.
	WebhookEndpointURL string `json:"webhookEndpointUrl,omitempty"`
	// WebhookSecret is the shared secret for authenticating inbound webhook or SCIM deliveries.
	// This value is only populated on initial creation and should be captured by the caller.
	WebhookSecret string `json:"webhookSecret,omitempty"`
}

type CreateTrustCenterAnonymousJWTResponse struct {
	// AuthData is the authdata value.
	AuthData
}

type DeleteIntegrationRequest struct {
	// ID is the id value.
	ID string `param:"id" description:"Integration ID" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type DeleteIntegrationResponse struct {
	// Reply is the reply value
	rout.Reply
	// Message is a user-facing summary of the disconnect action
	Message string `json:"message"`
	// DeletedID is the installation record ID that was removed
	DeletedID string `json:"deletedId,omitempty"`
	// RedirectURL is a provider URL the user should visit to complete external teardown
	RedirectURL string `json:"redirectUrl,omitempty"`
	// Details is an opaque provider-specific payload describing teardown actions taken or required
	Details json.RawMessage `json:"details,omitempty"`
}

type DisconnectIntegrationRequest struct {
	// IntegrationID is the integration ID to disconnect
	IntegrationID string `param:"integrationID" description:"Integration ID to disconnect" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

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

type EndImpersonationResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message" description:"Success message"`
}

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

type ExampleProvider interface {
	ExampleResponse() any
}

type ExampleSetProvider interface {
	ExampleSet() map[string]any
}

type File = storagetypes.File

type FileDownload struct {
	// ID is the id value.
	ID string `param:"id" description:"the file ID" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
	// Token is the token value.
	Token string `query:"token" description:"The token to be used to verify the email address, token is sent via email"`
}

type FileDownloadResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// File is the file value.
	File File `json:"file" description:"The files that were uploaded"`
}

type ForgotPasswordRequest struct {
	// Email is the email value.
	Email string `` /* 136-byte string literal not displayed */
}

type ForgotPasswordResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
}

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

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

type GetQuestionnaireResponse struct {
	// Jsonconfig is the jsonconfig value.
	Jsonconfig map[string]any `json:"jsonconfig,omitempty"`
	// UISchema is the uischema value.
	UISchema map[string]any `json:"uischema,omitempty"`
	// SavedData is the previously saved draft data, if any.
	SavedData map[string]any `json:"saved_data,omitempty"`
}

type GitHubAppWebhookResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Persisted is the persisted value.
	Persisted map[string]any `json:"persisted,omitempty" description:"Summary of persisted alerts"`
}

type IntegrationAuthStartRequest struct {
	// DefinitionID is the canonical integration definition identifier.
	DefinitionID string `json:"definitionId" description:"Integration definition ID" example:"def_01K0SLACK000000000000000001"`
	// IntegrationID is the existing installation to start the auth flow for; when omitted a new installation is created.
	IntegrationID string `json:"integrationId,omitempty"`
	// CredentialRef selects which credential-schema-defined connection is being activated.
	CredentialRef string `json:"credentialRef"`
	// UserInput holds optional installation-scoped provider configuration.
	UserInput json.RawMessage `json:"userInput,omitempty"`
}

type IntegrationConfig struct {
	// ClientConfig is the client configuration JSON
	ClientConfig json.RawMessage `json:"clientConfig,omitempty"`
}

type IntegrationInstallationIdentity struct {
	// ExternalName is the human-readable name of the external entity
	// (e.g. Slack workspace name, Azure tenant display name, Google Workspace domain)
	ExternalName string `json:"externalName,omitempty"`
	// ExternalID is the machine identifier for the external entity
	// (e.g. Slack team ID, Azure tenant ID, AWS account ID, GitHub installation ID)
	ExternalID string `json:"externalId,omitempty"`
	// CredentialRef is the credential method used to set up the integration
	CredentialRef string `json:"credentialRef,omitempty"`
	// LastSuccessfulHealthCheck is the RFC3339 timestamp of the last successful validation operation
	LastSuccessfulHealthCheck string `json:"lastSuccessfulHealthCheck,omitempty"`
}

type IntegrationInstallationMetadata struct {
	// Attributes is the provider-defined installation metadata payload
	Attributes json.RawMessage `json:"attributes,omitempty"`
	// Display is the normalized installation identity for UI rendering
	Display IntegrationInstallationIdentity `json:"display,omitzero"`
}

type IntegrationProviderMetadata struct {
	// Name is the provider's unique name
	Name string `json:"name"`
	// DisplayName is the human-readable provider name
	DisplayName string `json:"displayName"`
	// Category is the provider category
	Category string `json:"category"`
	// Description is the provider description
	Description string `json:"description,omitempty"`
	// AuthType is the authentication type
	AuthType string `json:"authType"`
	// AuthStartPath is the path to start authentication
	AuthStartPath string `json:"authStartPath,omitempty"`
	// AuthCallbackPath is the path for authentication callback
	AuthCallbackPath string `json:"authCallbackPath,omitempty"`
	// Active indicates if the provider is active
	Active bool `json:"active"`
	// Visible indicates if the provider is visible
	Visible bool `json:"visible"`
	// Tags is a list of provider tags
	Tags []string `json:"tags,omitempty"`
	// LogoURL is the URL to the provider logo
	LogoURL string `json:"logoUrl,omitempty"`
	// DocsURL is the URL to the provider documentation
	DocsURL string `json:"docsUrl,omitempty"`
	// EnvironmentCredentials is the environment credentials JSON
	EnvironmentCredentials json.RawMessage `json:"environmentCredentials,omitempty"`
	// CredentialsSchema is the credentials schema JSON
	CredentialsSchema json.RawMessage `json:"credentialsSchema,omitempty"`
	// Persistence is the persistence configuration
	Persistence map[string]any `json:"persistence,omitempty"`
	// Labels is a set of provider labels
	Labels map[string]string `json:"labels,omitempty"`
}

type IntegrationProviderState struct {
	// Providers is a map of provider keys to raw state JSON
	Providers map[string]json.RawMessage `json:"providers,omitempty"`
}

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

type InviteResponse struct {
	// Reply is the reply value.
	rout.Reply
	// ID is the user_id value.
	ID string `json:"user_id" description:"The ID of the user that was created" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// Email is the email value.
	Email string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	// Message is the message value.
	Message string `json:"message"`
	// JoinedOrgID is the joined_org_id value.
	JoinedOrgID string `json:"joined_org_id" description:"The ID of the organization the user joined" example:"01JJFVMGENQS9ZG3GVA50QVX5E"`
	// Role is the role value.
	Role string `json:"role" description:"The role the user has in the organization" example:"admin"`
	// NeedsSSO is the needs_sso value.
	NeedsSSO bool `json:"needs_sso,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

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

type LoginRequest struct {
	// Username is the username value.
	Username string `json:"username" description:"The email address associated with the existing account" example:"jsnow@example.com"`
	// Password is the password value.
	Password string `json:"password" description:"The password associated with the account" example:"Wint3rIsC0ming123!"`
	// TargetOrganizationID is only used for the Openlane support login path to scope the support session
	TargetOrganizationID string `json:"target_organization_id,omitempty" description:"For Openlane support login only: the organization to access"`
	// Reason is only used for the Openlane support login path to record why support is accessing the org
	Reason string `json:"reason,omitempty" description:"For Openlane support login only: the reason for accessing the organization"`
}

type LoginResponse struct {
	// Reply is the reply value.
	rout.Reply
	// AuthData is the authdata value.
	AuthData
	// TFAEnabled is the tfa_enabled value.
	TFAEnabled bool `json:"tfa_enabled,omitempty"`
	// TFASetupRequired is the tfa_required value.
	TFASetupRequired bool `json:"tfa_required,omitempty"`
	// RedirectURI directs the caller to a second factor identity provider; set for the Openlane support login path
	RedirectURI string `json:"redirect_uri,omitempty"`
	// Message is the message value.
	Message string `json:"message"`
}

type LogoutRequest struct {
	// RefreshToken is an optional refresh_token value for API clients that do not use cookies.
	RefreshToken string `json:"refresh_token,omitempty" description:"Optional refresh token to revoke when not provided via cookie"`
}

type LogoutResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
}

type OAuthFlowRequest struct {
	// Provider is the provider value.
	Provider string `json:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
	// IntegrationID scopes the OAuth callback credential save to a specific integration record.
	IntegrationID string `` /* 136-byte string literal not displayed */
	// RedirectURI is the redirectUri value.
	RedirectURI string `` /* 126-byte string literal not displayed */
	// Scopes is the scopes value.
	Scopes []string `json:"scopes,omitempty" description:"Additional OAuth scopes to request"` // example: ["repo", "gist"]
}

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

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

type OrganizationRole struct {
	ID          string `json:"id" description:"The role relation ID" example:"policy_manager"`
	Name        string `json:"name" description:"The display name for the role" example:"Policy Manager"`
	Description string `json:"description" description:"The role description" example:"Manage all policies and procedures"`
}

type OrganizationRolesRequest struct {
	OrganizationID string   `` /* 174-byte string literal not displayed */
	Role           string   `json:"role" description:"The organization responsibility role to assign" example:"policy_manager"`
	UserIDs        []string `json:"user_ids,omitempty" description:"User IDs to assign the role to"`
	GroupIDs       []string `json:"group_ids,omitempty" description:"Group IDs to assign the role to"`
}

type OrganizationRolesResponse struct {
	rout.Reply
	OrganizationID string `json:"organization_id" description:"The ID of the organization the role was applied to" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
	Role           string `json:"role" description:"The organization responsibility role" example:"policy_manager"`
}

type ProductCatalogRequest struct {
	// IncludeBeta is the includebeta value.
	IncludeBeta bool `query:"include_beta" description:"Whether to include beta products in the catalog" example:"false"`
	// IncludePrivate is the includeprivate value.
	IncludePrivate bool `query:"include_private" description:"Whether to include private products in the catalog" example:"false"`
}

type ProductCatalogResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Catalog is the catalog value.
	models.Catalog
}

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

type RefreshResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

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

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

type ResendQuestionnaireRequest struct {
	// Email is the email address associated with the assessment response
	Email string `json:"email" description:"The email address associated with the assessment response"`
	// AssessmentID is the ID of the assessment
	AssessmentID string `json:"assessment_id" description:"The ID of the assessment"`
}

type ResendRequest struct {
	// Email is the email value.
	Email string `` /* 134-byte string literal not displayed */
}

type ResendResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
}

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

type ResetPasswordResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
}

type RolesRequest struct{}

type RolesResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Roles is a list of organization responsibility roles that can be assigned.
	Roles []OrganizationRole `json:"roles,omitempty" description:"Organization roles and responsibilities that can be assigned"`
}

type RunIntegrationOperationBody struct {
	// Operation is the operation identifier.
	Operation string `json:"operation"`
	// Config holds optional operation-specific configuration as a raw JSON object.
	Config json.RawMessage `json:"config,omitempty"`
}

type RunIntegrationOperationRequest struct {
	// IntegrationID is the installation record to run the operation against.
	IntegrationID string `param:"integrationID" description:"Integration installation ID" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
	// Body holds the operation name and optional configuration.
	Body RunIntegrationOperationBody `json:"body"`
}

type RunIntegrationOperationResponse struct {
	rout.Reply
	// Provider is the integration definition ID.
	Provider string `json:"provider"`
	// Operation is the operation identifier that was executed.
	Operation string `json:"operation"`
	// Status is the operation result status (e.g. ok, queued, error).
	Status string `json:"status"`
	// Summary is a human-readable description of the result.
	Summary string `json:"summary,omitempty"`
	// Details holds structured result data specific to the operation.
	Details json.RawMessage `json:"details,omitempty"`
}

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

type SSOInitiateRequest struct {
	// SlugName is the organization slug used to resolve which organization's SSO flow to start
	SlugName string `param:"slug_name" description:"the organization slug" example:"acme"`
}

type SSOLoginRequest struct {
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id" query:"organization_id" description:"organization id" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// ReturnURL is the return value.
	ReturnURL string `json:"return" query:"return" description:"return url after authentication" example:"https://app.mitb.com"`
	// IsTest is the is_test value.
	IsTest bool `json:"is_test" query:"is_test" description:"Used when testing the sso was successfully connected"`
}

type SSOLoginResponse struct {
	// Reply is the reply value.
	rout.Reply
	// RedirectURI is the redirect_uri value.
	RedirectURI string `json:"redirect_uri,omitempty"`
}

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

type SSOStatusResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Enforced is the enforced value.
	Enforced bool `json:"enforced"`
	// Provider is the provider value.
	Provider enums.SSOProvider `json:"provider,omitempty"`
	// DiscoveryURL is the discovery_url value.
	DiscoveryURL string `json:"discovery_url,omitempty"`
	// SAMLSignInURL is the saml_signin_url value.
	SAMLSignInURL string `json:"saml_signin_url,omitempty"`
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id,omitempty"`
	// OrgTFAEnforced is the tfa_enforced value.
	OrgTFAEnforced bool `json:"tfa_enforced"`
	// UserTFAEnabled is the user_tfa_enabled value.
	UserTFAEnabled bool `json:"user_tfa_enabled,omitempty"`
	// IsOrgOwner is the is_org_owner value.
	IsOrgOwner bool `json:"is_org_owner,omitempty"`
}

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

type SSOTokenAuthorizeResponse struct {
	// Reply is the reply value.
	rout.Reply
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id"`
	// TokenID is the token_id value.
	TokenID string `json:"token_id"`
	// Message is the message value.
	Message string `json:"message,omitempty"`
}

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

type ScopesRequest struct{}

type ScopesResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Scopes is a map of object types to the scopes
	Scopes map[string][]string `json:"scopes,omitempty" description:"A map of object types to operations that can be set for an API Token"`
}

type SnapshotRequest struct {
	// URL is the url value.
	URL string `json:"url" description:"The URL of the domain to take a snapshot of" example:"https://www.example.com"`
	// WaitForSelector is the waitForSelector value.
	WaitForSelector string `` /* 132-byte string literal not displayed */
}

type SnapshotResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
	// Image is the image value.
	Image string `json:"image" description:"Base64-encoded image data of the snapshot"`
	// MIMEType is the mimeType value.
	MIMEType string `json:"mimeType" description:"MIME type of the snapshot image" example:"image/png"`
}

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

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

type StripeWebhookRequest struct {
	// APIVersion is the apiversion value.
	APIVersion string `query:"api_version" description:"Stripe API version for this webhook request" example:"2024-11-20.acacia"`
}

type SubmitQuestionnaireRequest struct {
	// AssessmentID is the assessment_id value.
	AssessmentID string `json:"assessment_id,omitempty"`
	// Data is the data value.
	Data map[string]any `json:"data" binding:"required"`
	// IsDraft when true saves partial progress without completing the questionnaire.
	IsDraft bool `json:"is_draft,omitempty"`
}

type SubmitQuestionnaireResponse struct {
	// DocumentDataID is the document_data_id value.
	DocumentDataID string `json:"document_data_id"`
	// Status is the status value.
	Status string `json:"status"`
	// CompletedAt is the completed_at value.
	CompletedAt string `json:"completed_at,omitempty"`
}

type SupportAccessResponse struct {
	// Reply is the reply value
	rout.Reply
	// AuthData contains the session token required for subsequent authenticated requests
	AuthData
	// Token is the support session token to use as the Impersonation Authorization scheme
	Token string `json:"token" description:"The support access token"`
	// ExpiresAt is when the support token expires
	ExpiresAt time.Time `json:"expires_at" description:"When the support access token expires"`
	// SessionID is the support access session id
	SessionID string `json:"session_id" description:"The support access session ID"`
	// OrganizationID is the organization the support session is scoped to, for the impersonation banner
	OrganizationID string `json:"organization_id" description:"The organization the support session is scoped to"`
	// Impersonator is the individual who completed the second factor, for the impersonation banner and audit
	Impersonator string `json:"impersonator" description:"The individual acting in the support session"`
	// Message is a human readable success message
	Message string `json:"message" description:"Success message"`
}

type SupportCallbackRequest struct {
	// Code is the authorization code returned by the identity provider
	Code string `json:"code" query:"code" description:"authorization code"`
	// State is the state value returned by the identity provider
	State string `json:"state" query:"state" description:"state value"`
}

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

type SwitchOrganizationResponse struct {
	// Reply is the reply value.
	rout.Reply
	// AuthData is the authdata value.
	AuthData
	// NeedsSSO is the needs_sso value.
	NeedsSSO bool `json:"needs_sso,omitempty"`
	// NeedsTFA is the needs_tfa value.
	NeedsTFA bool `json:"needs_tfa,omitempty"`
	// RedirectURI is the redirect_uri value.
	RedirectURI string `json:"redirect_uri,omitempty"`
}

type TFARequest struct {
	// TOTPCode is the totp_code value.
	TOTPCode string `` /* 127-byte string literal not displayed */
	// RecoveryCode is the recovery_code value.
	RecoveryCode string `` /* 133-byte string literal not displayed */
}

type TFAResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
}

type UnsubscribeRequest struct {
	// Token is the token value.
	Token string `query:"token" description:"The token to be used to unsubscribe, token is sent via email"`
}

type UnsubscribeResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
}

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

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

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

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

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

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

type VerifySubscribeResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
}

type WebauthnBeginLoginResponse struct {
	// Reply is the reply value.
	Reply rout.Reply
	// CredentialAssertion is the credentialassertion value.
	*protocol.CredentialAssertion
	// Session is the session value.
	Session string `json:"session,omitempty"`
}

type WebauthnBeginRegistrationResponse struct {
	// Reply is the reply value.
	Reply rout.Reply
	// CredentialCreation is the credentialcreation value.
	*protocol.CredentialCreation
	// Session is the session value.
	Session string `json:"session,omitempty"`
}

type WebauthnLoginFinishRequest struct {
	// ID is the id value.
	ID string `json:"id" description:"The credential ID"`
	// RawID is the rawId value.
	RawID string `json:"rawId" description:"The raw credential ID"`
	// Type is the type value.
	Type string `json:"type" description:"The credential type, should be 'public-key'"`
	// AuthenticatorAttachment is the authenticatorAttachment value.
	AuthenticatorAttachment string `json:"authenticatorAttachment,omitempty" description:"How the authenticator is attached"`
	// ClientExtensionResults is the clientExtensionResults value.
	ClientExtensionResults map[string]interface{} `json:"clientExtensionResults,omitempty" description:"Extension results"`
	// Response is the response value.
	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 is the email value.
	Email string `json:"email,omitempty" description:"The email address associated with the account" example:"jsnow@example.com"`
}

type WebauthnLoginResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

type WebauthnRegistrationFinishRequest struct {
	// ID is the id value.
	ID string `json:"id" description:"The credential ID"`
	// RawID is the rawId value.
	RawID string `json:"rawId" description:"The raw credential ID"`
	// Type is the type value.
	Type string `json:"type" description:"The credential type, should be 'public-key'"`
	// AuthenticatorAttachment is the authenticatorAttachment value.
	AuthenticatorAttachment string `json:"authenticatorAttachment,omitempty" description:"How the authenticator is attached"`
	// ClientExtensionResults is the clientExtensionResults value.
	ClientExtensionResults map[string]interface{} `json:"clientExtensionResults,omitempty" description:"Extension results"`
	// Response is the response value.
	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 is the email value.
	Email string `json:"email" description:"The email address associated with the account" example:"jsnow@example.com"`
	// Name is the name value.
	Name string `json:"name,omitempty" description:"The name of the user" example:"Jon Snow"`
}

type WebauthnRegistrationResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

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