openapi

package

Go to main page

Versions in this module

v1

v1.0.9

Feb 16, 2026

Changes in this version

+ var ExampleGitHubAppInstallCallbackRequest = GitHubAppInstallCallbackRequest

+ var ExampleGitHubAppInstallCallbackResponse = GitHubAppInstallCallbackResponse

+ var ExampleGitHubAppInstallRequest = GitHubAppInstallRequest

+ var ExampleGitHubAppInstallResponse = GitHubAppInstallResponse

type GetQuestionnaireResponse

+ SavedData map[string]any

+ type GitHubAppInstallCallbackRequest struct

+ InstallationID string

+ SetupAction string

+ State string

+ func (r *GitHubAppInstallCallbackRequest) Validate() error

+ type GitHubAppInstallCallbackResponse struct

+ Message string

+ func (r *GitHubAppInstallCallbackResponse) ExampleResponse() any

+ type GitHubAppInstallRequest struct

+ func (r *GitHubAppInstallRequest) Validate() error

+ type GitHubAppInstallResponse struct

+ InstallURL string

+ Message string

+ State string

+ func (r *GitHubAppInstallResponse) ExampleResponse() any

+ type GitHubAppWebhookResponse struct

+ Persisted map[string]any

+ func (r *GitHubAppWebhookResponse) ExampleResponse() any

type SubmitQuestionnaireRequest

+ IsDraft bool

v1.0.8

Feb 7, 2026

Changes in this version

+ type IntegrationConfig struct

+ ClientConfig map[string]any

+ CollectionStrategy string

+ EnabledOperations []string

+ MappingOverrides map[string]IntegrationMappingOverride

+ OperationTemplates map[string]IntegrationOperationTemplate

+ PollInterval time.Duration

+ RetentionPolicy *IntegrationRetentionPolicy

+ Schedule string

+ type IntegrationGitHubState = state.GitHubState

+ type IntegrationMappingOverride struct

+ FilterExpr string

+ MapExpr string

+ Version string

+ type IntegrationOperationTemplate struct

+ AllowOverrides []string

+ Config map[string]any

+ type IntegrationProviderState = state.IntegrationProviderState

+ type IntegrationRetentionPolicy struct

+ PayloadTTL time.Duration

+ StoreRawPayload bool

+ type IntegrationSlackState = state.SlackState

v1.0.7

Feb 3, 2026

v1.0.6

Jan 30, 2026

v1.0.5

Jan 29, 2026

Changes in this version

+ var ExampleSnapshotSuccessRequest = SnapshotRequest

+ var ExampleSnapshotSuccessResponse = SnapshotReply

+ type SnapshotReply struct

+ Image string

+ MIMEType string

+ Message string

+ func (r *SnapshotReply) ExampleResponse() any

+ type SnapshotRequest struct

+ URL string

+ WaitForSelector string

+ func (r *SnapshotRequest) Validate() error

v1.0.4

Jan 24, 2026

v1.0.3

Jan 19, 2026

v1.0.2

Jan 16, 2026

v1.0.1

Jan 14, 2026

v1.0.0

Dec 30, 2025

v0

v0.1.0

Dec 29, 2025

Changes in this version

+ const MaxImpersonationReasonLength

+ const MinImpersonationReasonLength

+ var ExampleAccountAccessReply = AccountAccessReply

+ var ExampleAccountAccessRequest = AccountAccessRequest

+ var ExampleAccountFeaturesReply = AccountFeaturesReply

+ var ExampleAccountFeaturesRequest = AccountFeaturesRequest

+ var ExampleAccountRolesOrganizationReply = AccountRolesOrganizationReply

+ var ExampleAccountRolesOrganizationRequest = AccountRolesOrganizationRequest

+ var ExampleAccountRolesReply = AccountRolesReply

+ var ExampleAccountRolesRequest = AccountRolesRequest

+ var ExampleAcmeSolverRequest = AcmeSolverRequest

+ var ExampleAvailableAuthTypeRequest = LoginRequest

+ var ExampleAvailableAuthTypeSuccessResponse = AvailableAuthTypeReply

+ var ExampleCreateTrustCenterAnonymousJWTResponse = CreateTrustCenterAnonymousJWTResponse

+ var ExampleDisconnectIntegrationRequest = DisconnectIntegrationRequest

+ var ExampleEndImpersonationReply = EndImpersonationReply

+ var ExampleEndImpersonationRequest = EndImpersonationRequest

+ var ExampleExampleCSVRequest = ExampleCSVRequest

+ var ExampleFileDownloadRequest = FileDownload

+ var ExampleForgotPasswordSuccessRequest = ForgotPasswordRequest

+ var ExampleForgotPasswordSuccessResponse = ForgotPasswordReply

+ var ExampleGetQuestionnaireResponse = GetQuestionnaireResponse

+ var ExampleIntegrationConfigParams = IntegrationConfigParams

+ var ExampleIntegrationConfigPayload = IntegrationConfigPayload

+ var ExampleIntegrationConfigRequest = IntegrationConfigRequest

+ var ExampleIntegrationOperationPayload = IntegrationOperationPayload

+ var ExampleInviteRequest = InviteRequest

+ var ExampleInviteResponse = InviteReply

+ var ExampleJobRunnerRegistrationRequest = JobRunnerRegistrationRequest

+ var ExampleJobRunnerRegistrationResponse = JobRunnerRegistrationReply

+ var ExampleLoginSuccessRequest = LoginRequest

+ var ExampleLoginSuccessResponse = LoginReply

+ var ExampleOAuthCallbackRequest = OAuthCallbackRequest

+ var ExampleOAuthCallbackResponse = OAuthCallbackResponse

+ var ExampleOAuthFlowRequest = OAuthFlowRequest

+ var ExampleOAuthFlowResponse = OAuthFlowResponse

+ var ExampleOauthTokenRequest = OauthTokenRequest

+ var ExampleProductCatalogReply = ProductCatalogReply

+ var ExampleProductCatalogRequest = ProductCatalogRequest

+ var ExampleRefreshIntegrationTokenRequest = RefreshIntegrationTokenRequest

+ var ExampleRefreshRequest = RefreshRequest

+ var ExampleRefreshSuccessResponse = RefreshReply

+ var ExampleRegisterSuccessRequest = RegisterRequest

+ var ExampleRegisterSuccessResponse = RegisterReply

+ var ExampleResendEmailSuccessRequest = ResendRequest

+ var ExampleResendEmailSuccessResponse = ResendReply

+ var ExampleResetPasswordSuccessRequest = ResetPasswordRequest

+ var ExampleResetPasswordSuccessResponse = ResetPasswordReply

+ var ExampleSSOCallbackRequest = SSOCallbackRequest

+ var ExampleSSOLoginRequest = SSOLoginRequest

+ var ExampleSSOStatusReply = SSOStatusReply

+ var ExampleSSOStatusRequest = SSOStatusRequest

+ var ExampleSSOTokenAuthorizeReply = SSOTokenAuthorizeReply

+ var ExampleSSOTokenAuthorizeRequest = SSOTokenAuthorizeRequest

+ var ExampleSSOTokenCallbackRequest = SSOTokenCallbackRequest

+ var ExampleStartImpersonationReply = StartImpersonationReply

+ var ExampleStartImpersonationRequest = StartImpersonationRequest

+ var ExampleSubmitQuestionnaireRequest = SubmitQuestionnaireRequest

+ var ExampleSubmitQuestionnaireResponse = SubmitQuestionnaireResponse

+ var ExampleSwitchSuccessReply = SwitchOrganizationReply

+ var ExampleSwitchSuccessRequest = SwitchOrganizationRequest

+ var ExampleTFASSuccessResponse = TFAReply

+ var ExampleTFASuccessRequest = TFARequest

+ var ExampleUploadFileRequest = UploadFilesRequest

+ var ExampleUploadFilesSuccessResponse = UploadFilesReply

+ var ExampleUserInfoSuccessResponse = UserInfoReply

+ var ExampleVerifySubscriptionResponse = VerifySubscribeReply

+ var ExampleVerifySubscriptionSuccessRequest = VerifySubscribeRequest

+ var ExampleVerifySuccessRequest = VerifyRequest

+ var ExampleVerifySuccessResponse = VerifyReply

+ var ExampleWebauthnBeginLoginResponse = WebauthnBeginLoginResponse

+ var ExampleWebauthnBeginRegistrationRequest = WebauthnRegistrationRequest

+ var ExampleWebauthnBeginRegistrationResponse = WebauthnBeginRegistrationResponse

+ var ExampleWebauthnLoginFinishRequest = WebauthnLoginFinishRequest

+ var ExampleWebauthnLoginRequest = WebauthnLoginRequest

+ var ExampleWebauthnLoginResponse = WebauthnLoginResponse

+ var ExampleWebauthnRegistrationFinishRequest = WebauthnRegistrationFinishRequest

+ var ExampleWebauthnRegistrationResponse = WebauthnRegistrationResponse

+ var ExampleWebfingerRequest = WebfingerRequest

+ type AccountAccessReply struct

+ Allowed bool

+ func (r *AccountAccessReply) ExampleResponse() any

+ type AccountAccessRequest struct

+ ObjectID string

+ ObjectType string

+ Relation string

+ SubjectType string

+ func (r *AccountAccessRequest) Validate() error

+ type AccountFeaturesReply struct

+ Features []string

+ OrganizationID string

+ func (r *AccountFeaturesReply) ExampleResponse() any

+ type AccountFeaturesRequest struct

+ ID string

+ func (r *AccountFeaturesRequest) Validate() error

+ type AccountRolesOrganizationReply struct

+ OrganizationID string

+ Roles []string

+ func (r *AccountRolesOrganizationReply) ExampleResponse() any

+ type AccountRolesOrganizationRequest struct

+ ID string

+ func (r *AccountRolesOrganizationRequest) Validate() error

+ type AccountRolesReply struct

+ ObjectRoles map[string][]string

+ Roles []string

+ func (r *AccountRolesReply) ExampleResponse() any

+ type AccountRolesRequest struct

+ ObjectID string

+ ObjectIDs []string

+ ObjectType string

+ Relations []string

+ SubjectType string

+ func (r *AccountRolesRequest) Validate() error

+ type AcmeSolverRequest struct

+ Path string

+ type AuthData struct

+ AccessToken string

+ RefreshToken string

+ Session string

+ TokenType string

+ type AvailableAuthTypeLoginRequest struct

+ Username string

+ func (r *AvailableAuthTypeLoginRequest) Validate() error

+ type AvailableAuthTypeReply struct

+ Methods []enums.AuthProvider

+ func (r *AvailableAuthTypeReply) ExampleResponse() any

+ type CreateTrustCenterAnonymousJWTResponse struct

+ func (r *CreateTrustCenterAnonymousJWTResponse) ExampleResponse() any

+ type DeleteIntegrationRequest struct

+ ID string

+ func (r *DeleteIntegrationRequest) Validate() error

+ type DeleteIntegrationResponse struct

+ DeletedID string

+ Message string

+ type DisconnectIntegrationRequest struct

+ IntegrationID string

+ Provider string

+ type EndImpersonationReply struct

+ Message string

+ func (r *EndImpersonationReply) ExampleResponse() any

+ type EndImpersonationRequest struct

+ Reason string

+ SessionID string

+ func (r *EndImpersonationRequest) Validate() error

+ type ExampleCSVRequest struct

+ Filename string

+ func (r *ExampleCSVRequest) Validate() error

+ type ExampleProvider interface

+ ExampleResponse func() any

+ type File = storagetypes.File

+ type FileDownload struct

+ ID string

+ Token string

+ func (r *FileDownload) Validate() error

+ type FileDownloadReply struct

+ File File

+ Message string

+ func (r *FileDownloadReply) ExampleResponse() any

+ type ForgotPasswordReply struct

+ Message string

+ func (r *ForgotPasswordReply) ExampleResponse() any

+ type ForgotPasswordRequest struct

+ Email string

+ func (r *ForgotPasswordRequest) Validate() error

+ type GetIntegrationStatusRequest struct

+ Provider string

+ func (r *GetIntegrationStatusRequest) Validate() error

+ type GetIntegrationTokenRequest struct

+ Provider string

+ func (r *GetIntegrationTokenRequest) Validate() error

+ type GetQuestionnaireResponse struct

+ Jsonconfig map[string]any

+ UISchema map[string]any

+ func (r *GetQuestionnaireResponse) ExampleResponse() any

+ type IntegrationConfigParams struct

+ Provider string

+ type IntegrationConfigPayload struct

+ Body IntegrationConfigRequest

+ type IntegrationConfigRequest struct

+ Additional map[string]any

+ Audience string

+ FindingFilter string

+ OrganizationID string

+ ProjectID string

+ ServiceAccountEmail string

+ WorkloadIdentityProvider string

+ func (r *IntegrationConfigRequest) UnmarshalJSON(data []byte) error

+ func (r IntegrationConfigRequest) ToMap() map[string]any

+ type IntegrationConfigResponse struct

+ Provider string

+ func (r *IntegrationConfigResponse) ExampleResponse() any

+ type IntegrationOAuthMetadata struct

+ AuthParams map[string]string

+ AuthURL string

+ RedirectURI string

+ Scopes []string

+ TokenParams map[string]string

+ TokenURL string

+ UsePKCE bool

+ type IntegrationOperationMetadata struct

+ Client string

+ ConfigSchema map[string]any

+ Description string

+ Kind string

+ Name string

+ type IntegrationOperationParams struct

+ Provider string

+ type IntegrationOperationPayload struct

+ Body IntegrationOperationRequest

+ type IntegrationOperationRequest struct

+ Config map[string]any

+ Force bool

+ Operation string

+ type IntegrationOperationResponse struct

+ Details map[string]any

+ Operation string

+ Provider string

+ Status string

+ Summary string

+ func (r *IntegrationOperationResponse) ExampleResponse() any

+ type IntegrationProviderMetadata struct

+ Active bool

+ AuthType types.AuthKind

+ Category string

+ CredentialsSchema map[string]any

+ DisplayName string

+ DocsURL string

+ GitHubApp *config.GitHubAppSpec

+ GoogleWorkloadIdentity *config.GoogleWorkloadIdentitySpec

+ Labels map[string]string

+ LogoURL string

+ Name string

+ OAuth *IntegrationOAuthMetadata

+ Operations []IntegrationOperationMetadata

+ Persistence *config.PersistenceSpec

+ type IntegrationProvidersResponse struct

+ Providers []IntegrationProviderMetadata

+ Schema *jsonschema.Schema

+ type IntegrationStatusResponse struct

+ Connected bool

+ Integration any

+ Message string

+ Provider string

+ Status string

+ TokenExpired bool

+ TokenValid bool

+ func (r *IntegrationStatusResponse) ExampleResponse() any

+ type IntegrationToken struct

+ AccessToken string

+ ExpiresAt *time.Time

+ Provider string

+ ProviderEmail string

+ ProviderUserID string

+ ProviderUsername string

+ RefreshToken string

+ func (t *IntegrationToken) HasValidToken() bool

+ func (t *IntegrationToken) IsExpired() bool

+ type IntegrationTokenResponse struct

+ ExpiresAt *time.Time

+ Provider string

+ Token *IntegrationToken

+ func (r *IntegrationTokenResponse) ExampleResponse() any

+ type InviteReply struct

+ Email string

+ ID string

+ JoinedOrgID string

+ Message string

+ NeedsSSO bool

+ Role string

+ func (r *InviteReply) ExampleResponse() any

+ type InviteRequest struct

+ Token string

+ func (r *InviteRequest) Validate() error

+ type JobRunnerRegistrationReply struct

+ Message string

+ Reply rout.Reply

+ func (r *JobRunnerRegistrationReply) ExampleResponse() any

+ type JobRunnerRegistrationRequest struct

+ IPAddress string

+ Name string

+ Tags []string

+ Token string

+ func (r *JobRunnerRegistrationRequest) Validate() error

+ type ListIntegrationsResponse struct

+ Integrations any

+ type LoginReply struct

+ Message string

+ TFAEnabled bool

+ TFASetupRequired bool

+ func (r *LoginReply) ExampleResponse() any

+ type LoginRequest struct

+ Password string

+ Username string

+ func (r *LoginRequest) Validate() error

+ type OAuthCallbackRequest struct

+ Code string

+ Provider string

+ State string

+ func (r *OAuthCallbackRequest) Validate() error

+ type OAuthCallbackResponse struct

+ Integration any

+ Message string

+ Success bool

+ func (r *OAuthCallbackResponse) ExampleResponse() any

+ type OAuthFlowRequest struct

+ Provider string

+ RedirectURI string

+ Scopes []string

+ func (r *OAuthFlowRequest) Validate() error

+ type OAuthFlowResponse struct

+ AuthURL string

+ Message string

+ RequiresLogin bool

+ State string

+ func (r *OAuthFlowResponse) ExampleResponse() any

+ type OauthTokenRequest struct

+ AuthProvider string

+ ClientToken string

+ Email string

+ ExternalUserID string

+ ExternalUserName string

+ Image string

+ Name string

+ OrgID string

+ type ProductCatalogReply struct

+ func (r *ProductCatalogReply) ExampleResponse() any

+ type ProductCatalogRequest struct

+ IncludeBeta bool

+ IncludePrivate bool

+ func (r *ProductCatalogRequest) Validate() error

+ type RefreshIntegrationTokenRequest struct

+ Provider string

+ func (r *RefreshIntegrationTokenRequest) Validate() error

+ type RefreshReply struct

+ Message string

+ func (r *RefreshReply) ExampleResponse() any

+ type RefreshRequest struct

+ RefreshToken string

+ func (r *RefreshRequest) Validate() error

+ type RegisterReply struct

+ Email string

+ ID string

+ Message string

+ Token string

+ func (r *RegisterReply) ExampleResponse() any

+ type RegisterRequest struct

+ Email string

+ FirstName string

+ LastName string

+ Password string

+ Token *string

+ func (r *RegisterRequest) Validate() error

+ type ResendReply struct

+ Message string

+ func (r *ResendReply) ExampleResponse() any

+ type ResendRequest struct

+ Email string

+ func (r *ResendRequest) Validate() error

+ type ResetPasswordReply struct

+ Message string

+ func (r *ResetPasswordReply) ExampleResponse() any

+ type ResetPasswordRequest struct

+ Password string

+ Token string

+ func (r *ResetPasswordRequest) Validate() error

+ type SSOCallbackRequest struct

+ Code string

+ OrganizationID string

+ State string

+ func (r *SSOCallbackRequest) Validate() error

+ type SSOLoginReply struct

+ RedirectURI string

+ type SSOLoginRequest struct

+ IsTest bool

+ OrganizationID string

+ ReturnURL string

+ func (r *SSOLoginRequest) Validate() error

+ type SSOStatusReply struct

+ DiscoveryURL string

+ Enforced bool

+ IsOrgOwner bool

+ OrgTFAEnforced bool

+ OrganizationID string

+ Provider enums.SSOProvider

+ SAMLSignInURL string

+ UserTFAEnabled bool

+ func (r *SSOStatusReply) ExampleResponse() any

+ type SSOStatusRequest struct

+ Resource string

+ func (r *SSOStatusRequest) Validate() error

+ type SSOTokenAuthorizeReply struct

+ Message string

+ OrganizationID string

+ TokenID string

+ func (r *SSOTokenAuthorizeReply) ExampleResponse() any

+ type SSOTokenAuthorizeRequest struct

+ OrganizationID string

+ TokenID string

+ TokenType string

+ func (r *SSOTokenAuthorizeRequest) Validate() error

+ type SSOTokenCallbackRequest struct

+ Code string

+ State string

+ func (r *SSOTokenCallbackRequest) Validate() error

+ type StartImpersonationReply struct

+ ExpiresAt time.Time

+ Message string

+ SessionID string

+ Token string

+ func (r *StartImpersonationReply) ExampleResponse() any

+ type StartImpersonationRequest struct

+ Duration *int

+ OrganizationID string

+ Reason string

+ Scopes []string

+ TargetUserID string

+ Type string

+ func (r *StartImpersonationRequest) Validate() error

+ type StripeWebhookRequest struct

+ APIVersion string

+ func (r *StripeWebhookRequest) Validate() error

+ type SubmitQuestionnaireRequest struct

+ AssessmentID string

+ Data map[string]any

+ type SubmitQuestionnaireResponse struct

+ CompletedAt string

+ DocumentDataID string

+ Status string

+ func (r *SubmitQuestionnaireResponse) ExampleResponse() any

+ type SwitchOrganizationReply struct

+ NeedsSSO bool

+ NeedsTFA bool

+ RedirectURI string

+ func (r *SwitchOrganizationReply) ExampleResponse() any

+ type SwitchOrganizationRequest struct

+ TargetOrganizationID string

+ func (r *SwitchOrganizationRequest) Validate() error

+ type TFAReply struct

+ Message string

+ func (r *TFAReply) ExampleResponse() any

+ type TFARequest struct

+ RecoveryCode string

+ TOTPCode string

+ func (r *TFARequest) Validate() error

+ type UploadFilesReply struct

+ FileCount int64

+ Files []File

+ Message string

+ func (r *UploadFilesReply) ExampleResponse() any

+ type UploadFilesRequest struct

+ UploadFile multipart.FileHeader

+ type UserInfoReply struct

+ AvatarRemoteURL *string

+ DisplayName string

+ Email string

+ FirstName string

+ ID string

+ LastName string

+ LastSeen *string

+ Role string

+ Sub string

+ type VerifyReply struct

+ Email string

+ ID string

+ Message string

+ func (r *VerifyReply) ExampleResponse() any

+ type VerifyRequest struct

+ Token string

+ func (r *VerifyRequest) Validate() error

+ type VerifySubscribeReply struct

+ Message string

+ type VerifySubscribeRequest struct

+ Token string

+ func (r *VerifySubscribeRequest) Validate() error

+ type WebauthnBeginLoginResponse struct

+ Reply rout.Reply

+ Session string

+ func (r *WebauthnBeginLoginResponse) ExampleResponse() any

+ type WebauthnBeginRegistrationResponse struct

+ Reply rout.Reply

+ Session string

+ func (r *WebauthnBeginRegistrationResponse) ExampleResponse() any

+ type WebauthnLoginFinishRequest struct

+ AuthenticatorAttachment string

+ ClientExtensionResults map[string]interface{}

+ ID string

+ RawID string

+ Response struct{ ... }

+ Type string

+ type WebauthnLoginRequest struct

+ Email string

+ func (r *WebauthnLoginRequest) Validate() error

+ type WebauthnLoginResponse struct

+ Message string

+ func (r *WebauthnLoginResponse) ExampleResponse() any

+ type WebauthnRegistrationFinishRequest struct

+ AuthenticatorAttachment string

+ ClientExtensionResults map[string]interface{}

+ ID string

+ RawID string

+ Response struct{ ... }

+ Type string

+ type WebauthnRegistrationRequest struct

+ Email string

+ Name string

+ func (r *WebauthnRegistrationRequest) Validate() error

+ type WebauthnRegistrationResponse struct

+ Message string

+ func (r *WebauthnRegistrationResponse) ExampleResponse() any

+ type WebfingerRequest struct

+ Resource string

+ func (r *WebfingerRequest) Validate() error

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