Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

21.2 KB
Raw Blame
# yaml-language-server: $schema=https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/HEAD/configuration-schema.json
package: api
output: clients/api/api.gen.go

generate:
  models: true
  client: true

output-options:
  overlay:
    path: clients/api/overlay.yaml
  # Only what the suite calls. Add an id here when a test reaches for a new endpoint.
  #
  # The route must also be in the spec, which needs OPENAPI_FULL_SPEC *and* a
  # non-production NODE_ENV on the instance being generated from -- env.ts resolves
  # isOpenApiFullSpec as `NODE_ENV !== "production" && OPENAPI_FULL_SPEC`, so the
  # harness's own container can never serve it. Generate from the dev stack. Half the
  # routes are hidden by default, and a route with no operationId gets a name derived
  # from its path that changes when the path does.
  include-operation-ids:
    - adminBootstrap
    - updateAdminConfig
    - getInstanceStatus
    - loginV3
    - selectOrganizationV3
    - refreshAuthToken
    - createOrganization
    - deleteOrganization
    - createProject
    - getOrganizationPlan
    - inviteUsersToOrganization
    - verifyUserToOrganization
    - beginEmailSignupV3
    - verifyEmailSignupV3
    - completeAccountSignupV3
    - inviteProjectMembers
    - removeProjectMembers
    - createMachineIdentity
    - createProjectMachineIdentity
    - createProjectIdentityMembership
    - createProjectRole
    - listProjectMachineIdentities
    - createGitHubAppConnection
    - createServiceNowAppConnection
    - createGitHubSecretSync
    - getGitHubSecretSync
    - deleteGitHubSecretSync
    - syncGitHubSecretSync
    - removeGitHubSecretSyncSecrets
    - deleteGitHubAppConnection
    - createVercelAppConnection
    - createVercelSecretSync
    - getVercelSecretSync
    - syncVercelSecretSync
    - attachUniversalAuth
    - createUniversalAuthClientSecret
    - loginWithUniversalAuth
    - createSecretV4
    - deleteSecretV4
    - getSecretByNameV4
    - listSecretsV4
    - updateSecretV4
    - getSecretByIdV4
    - moveSecretsV4
    - duplicateSecretV4
    - createManySecretsV4
    - updateManySecretsV4
    - deleteManySecretsV4
    - getSecretReferencesV4
    - getSecretReferenceTreeV4
    - listProjectSecretsDetails
    - createSecretFolder
    - createSecretTag
    - createSecretImport
    - createIdentityFolderAccess
    - updateOrganization
    - createProjectFolderGrant
    - deleteProjectFolderGrant
    - createSecretApprovalPolicy
    - updateSecretApprovalPolicy
    - deleteSecretApprovalPolicy
    - getSecretApprovalPolicy
    - getSecretApprovalPolicyBoard
    - listSecretApprovalRequests
    - getSecretApprovalRequestCount
    - getSecretApprovalRequest
    - reviewSecretApprovalRequest
    - updateSecretApprovalRequestStatus
    - mergeSecretApprovalRequest
    - createAccessApprovalPolicy
    - listAccessApprovalPolicies
    - updateAccessApprovalPolicy
    - getAccessApprovalPolicy
    - createAccessApprovalRequest
    - listAccessApprovalRequests
    - handleDelegatedApprovalCallback
    - createGroup
    - addUserToGroup
    - removeUserFromGroup
    - createProjectGroupMembership
    - getSamlConfig
    - createSamlConfig
    - updateSamlConfig
    - redirectSamlByOrgSlug
    - redirectSamlByDomain
    - redirectSamlByConfigId
    - redirectOrgSSO
    - samlAcs
    - createEmailDomain
    - verifyEmailDomain
    - listEmailDomains
    - getOrganizationById
    - listOrgMemberships
    - getOrgMembership
    - updateOrgMembership
    - getCurrentUser
    - accessSharedSecret
    - addGroupToProject
    - addMachineIdentityToGroup
    - addTrustedIp
    - assumeProjectPrivileges
    - backfillSecretReferencesV4
    - bulkDeleteOrgMemberships
    - checkAWSIAMUserSecretRotationCredentials
    - checkAwsParameterStoreSecretSyncDestination
    - checkAwsParameterStoreSecretSyncRecursiveConflicts
    - checkAwsSecretsManagerSecretSyncDestination
    - checkAwsSecretsManagerSecretSyncRecursiveConflicts
    - checkFolderMoveCheck
    - checkGitHubSecretSyncDestination
    - checkGitHubSecretSyncRecursiveConflicts
    - checkPostgreSQLCredentialsRotationCredentials
    - compareFolderCommit
    - createAWSIAMUserSecretRotation
    - createAwsAppConnection
    - createAwsParameterStoreSecretSync
    - createAwsSecretsManagerSecretSync
    - createBatchFolderCommit
    - createChefSecretSync
    - createDynamicSecret
    - createDynamicSecretLease
    - createEnvironment
    - createHoneyToken
    - createIdentityProjectAdditionalPrivilege
    - createIdentityProjectPermanentPrivilegeV1
    - createIdentityProjectTemporaryPrivilegeV1
    - createOciVaultSecretSync
    - createOrganizationGroupMembership
    - createOrganizationIdentityMembership
    - createOrganizationMachineIdentity
    - createPostgreSQLCredentialsRotation
    - createPostgresAppConnection
    - createProjectRoleV1
    - createProjectTemplate
    - createPublicSharedSecret
    - createSecretReminder
    - createSecretRequest
    - createServiceToken
    - createSharedSecret
    - createStaticSecretsValidationRule
    - createUserFolderAccess
    - createUserProjectAdditionalPrivilege
    - createWebhook
    - deepSearchSecrets
    - deleteAWSIAMUserSecretRotation
    - deleteAccessApprovalPolicy
    - deleteAssumedProjectPrivileges
    - deleteAwsAppConnection
    - deleteAwsParameterStoreSecretSync
    - deleteAwsSecretsManagerSecretSync
    - deleteDynamicSecret
    - deleteEnvironment
    - deleteGroup
    - deleteIdentityFolderAccess
    - deleteIdentityProjectAdditionalPrivilege
    - deleteIdentityProjectAdditionalPrivilegeV1
    - deleteMachineIdentity
    - deleteOrgMembership
    - deleteOrganizationGroupMembership
    - deleteOrganizationIdentityMembership
    - deleteOrganizationMachineIdentity
    - deletePostgreSQLCredentialsRotation
    - deletePostgresAppConnection
    - deleteProject
    - deleteProjectIdentityMembership
    - deleteProjectMachineIdentity
    - deleteProjectMembership
    - deleteProjectRole
    - deleteProjectRoleV1
    - deleteProjectTemplate
    - deleteSecretFolder
    - deleteSecretImport
    - deleteSecretReminder
    - deleteSecretRequest
    - deleteSecretTag
    - deleteServiceToken
    - deleteSharedSecret
    - deleteStaticSecretsValidationRule
    - deleteTrustedIp
    - deleteUserFolderAccess
    - deleteUserProjectAdditionalPrivilege
    - deleteWebhook
    - enableOrgWideSecretValueTracking
    - enableProjectSecretBlindIndex
    - getAWSIAMUserSecretRotation
    - getAWSIAMUserSecretRotationByName
    - getAWSIAMUserSecretRotationGeneratedCredentials
    - getAccessApprovalPolicyCount
    - getAccessApprovalRequestCount
    - getAccessibleSecretMetadata
    - getAwsAppConnection
    - getAwsAppConnectionByName
    - getAwsHoneyTokenConfig
    - getAwsParameterStoreSecretSync
    - getAwsParameterStoreSecretSyncByName
    - getAwsSecretsManagerSecretSync
    - getAwsSecretsManagerSecretSyncByName
    - getDynamicSecret
    - getDynamicSecretLease
    - getEnvironmentById
    - getEnvironmentBySlug
    - getFolderCommitChanges
    - getFolderCommitsCount
    - getFolderStateAtCommit
    - getGitHubAppConnection
    - getGitHubAppConnectionByName
    - getGitHubSecretSyncByName
    - getGroupById
    - getHoneyToken
    - getHoneyTokenCredentials
    - getHoneyTokenLimits
    - getIdentityProjectAdditionalPrivilege
    - getIdentityProjectAdditionalPrivilegeBySlug
    - getIdentityProjectAdditionalPrivilegeBySlugV1
    - getInsightsCounts
    - getInsightsSecretsDuplication
    - getInsightsSummary
    - getMachineIdentityById
    - getMachineIdentityDetails
    - getMachineIdentityMemberships
    - getMyPendingProjectAccessRequests
    - getOrgInsightsSecretsDuplication
    - getOrgWideSecretValueTrackingStatus
    - getOrganizationAuditLogSettings
    - getOrganizationGroupMembership
    - getOrganizationIdentityMembershipById
    - getOrganizationMachineIdentityById
    - getPostgreSQLCredentialsRotation
    - getPostgreSQLCredentialsRotationByName
    - getPostgreSQLCredentialsRotationGeneratedCredentials
    - getPostgresAppConnection
    - getPostgresAppConnectionByName
    - getProjectAuditLogSettings
    - getProjectById
    - getProjectBySlug
    - getProjectEnvironmentFolderTree
    - getProjectFolderGrantUsage
    - getProjectGroup
    - getProjectGroupMembership
    - getProjectIdentityMembershipById
    - getProjectMachineIdentityById
    - getProjectMembership
    - getProjectMembershipByUserId
    - getProjectMembershipByUsername
    - getProjectMembershipPermissionAudit
    - getProjectPermissionsV1
    - getProjectRoleByIdV1
    - getProjectRoleBySlug
    - getProjectRoleBySlugV1
    - getProjectSecretBlindIndexStatus
    - getProjectTemplateById
    - getRawSecretsFromImports
    - getSecretAccessList
    - getSecretFolderById
    - getSecretImport
    - getSecretImports
    - getSecretReminder
    - getSecretRequest
    - getSecretTagById
    - getSecretTagBySlug
    - getSecretValue
    - getSecretVersionValue
    - getSecretsByKeys
    - getSecretsProjects
    - getSecretsSummary
    - getServiceToken
    - getSharedSecretById
    - getStaticSecretsUsage
    - getStaticSecretsValidationRule
    - getUserProjectAdditionalPrivilege
    - getWebhookById
    - grantOrganizationAdminProjectAccess
    - importAwsParameterStoreSecretSyncSecrets
    - importAwsSecretsManagerSecretSyncSecrets
    - importGitHubSecretSyncSecrets
    - leaveProject
    - listAWSIAMUserSecretRotations
    - listAccessibleOrganizationsWithSubOrgs
    - listAccessibleProjectsWithSubOrgs
    - listAvailableOrganizationGroups
    - listAvailableOrganizationIdentities
    - listAvailableOrganizationMachineIdentities
    - listAvailableOrganizationUsers
    - listAvailableProjectIdentities
    - listAwsAppConnections
    - listAwsParameterStoreSecretSyncs
    - listAwsSecretsManagerSecretSyncs
    - listDynamicSecretLeases
    - listDynamicSecrets
    - listFolderAccessIdentities
    - listFolderAccessUsers
    - listFolderCommitAuthors
    - listFolderCommits
    - listGitHubAppConnections
    - listGitHubSecretSyncs
    - listGroupMachineIdentities
    - listGroupProjects
    - listGroupUsers
    - listGroups
    - listHoneyTokenEvents
    - listIdentityFolderAccess
    - listIdentityProjectAdditionalPrivileges
    - listIdentityProjectAdditionalPrivilegesV1
    - listMachineIdentities
    - listOrgIdentityMemberships
    - listOrgProjects
    - listOrganizationAuditLogs
    - listOrganizationGroupMemberships
    - listOrganizationGroups
    - listOrganizationIdentityMemberships
    - listOrganizationMachineIdentities
    - listOrganizationProjects
    - listOrganizationUsers
    - listPostgreSQLCredentialsRotations
    - listPostgresAppConnections
    - listProjectFolderGrants
    - listProjectGroupMemberships
    - listProjectGroupUsers
    - listProjectGroups
    - listProjectIdentityMemberships
    - listProjectMemberships
    - listProjectMembershipsByOrgMembership
    - listProjectRoles
    - listProjectRolesV1
    - listProjectSecretsOverview
    - listProjectServiceTokens
    - listProjectTemplates
    - listProjectUsers
    - listProjects
    - listReceivedProjectFolderGrants
    - listSecretApprovalPolicies
    - listSecretFolders
    - listSecretImports
    - listSecretRequests
    - listSecretTags
    - listSecretValidationRules
    - listSecretVersions
    - listSecretVersionsById
    - listSharedSecrets
    - listStaticSecretsValidationRules
    - listTrustedIps
    - listUserFolderAccess
    - listUserProjectAdditionalPrivileges
    - listWebhooks
    - moveAWSIAMUserSecretRotation
    - movePostgreSQLCredentialsRotation
    - moveSecretFolder
    - redactSecretVersionValue
    - removeAwsParameterStoreSecretSyncSecrets
    - removeAwsSecretsManagerSecretSyncSecrets
    - removeGroupFromProject
    - removeMachineIdentityFromGroup
    - removeProjectGroupMembership
    - renewDynamicSecretLease
    - requestProjectAccess
    - resetHoneyToken
    - restoreEnvironment
    - resyncSecretImportReplication
    - revealSecretRequestValue
    - revertFolderCommit
    - reviewAccessApprovalRequest
    - revokeAccessApprovalRequest
    - revokeDynamicSecretLease
    - revokeHoneyToken
    - rollbackFolderCommit
    - rotateAWSIAMUserSecretRotation
    - rotatePostgreSQLCredentialsRotation
    - searchMachineIdentities
    - searchOrgInsightsSecretsByValue
    - searchProjects
    - searchSecretsByMetadata
    - setSecretRequestValue
    - subscribeToProjectEvents
    - syncAwsParameterStoreSecretSync
    - syncAwsSecretsManagerSecretSync
    - testAwsHoneyTokenConfigConnection
    - testWebhook
    - triggerAwsHoneyToken
    - updateAWSIAMUserSecretRotation
    - updateAccessApprovalRequest
    - updateAwsAppConnection
    - updateAwsParameterStoreSecretSync
    - updateAwsSecretsManagerSecretSync
    - updateDynamicSecret
    - updateEnvironment
    - updateGitHubAppConnection
    - updateGitHubSecretSync
    - updateGroup
    - updateHoneyToken
    - updateIdentityFolderAccess
    - updateIdentityProjectAdditionalPrivilege
    - updateIdentityProjectAdditionalPrivilegeV1
    - updateMachineIdentity
    - updateOrganizationAuditLogSettings
    - updateOrganizationGroupMembership
    - updateOrganizationIdentityMembership
    - updateOrganizationMachineIdentity
    - updatePostgreSQLCredentialsRotation
    - updatePostgresAppConnection
    - updateProject
    - updateProjectAuditLogSettings
    - updateProjectAuditLogsRetention
    - updateProjectGroup
    - updateProjectGroupMembership
    - updateProjectIdentityMembership
    - updateProjectMachineIdentity
    - updateProjectMembership
    - updateProjectRole
    - updateProjectRoleV1
    - updateProjectTemplate
    - updateSecretFolder
    - updateSecretFoldersBatch
    - updateSecretImport
    - updateSecretTag
    - updateStaticSecretsValidationRule
    - updateTrustedIp
    - updateUserFolderAccess
    - updateUserProjectAdditionalPrivilege
    - updateWebhook
    - upgradePrivilegeSystem
    - upgradeProject
    - uploadProjectKey
    - upsertAwsHoneyTokenConfig
    - deleteUser
    - createScimToken
    - listScimTokens
    - deleteScimToken
    - listScimEvents
    - getScimServiceProviderConfig
    - listScimUsers
    - getScimUser
    - createScimUser
    - replaceScimUser
    - patchScimUser
    - deleteScimUser
    - listScimGroups
    - getScimGroup
    - createScimGroup
    - replaceScimGroup
    - patchScimGroup
    - deleteScimGroup
    - createOidcConfig
    - updateOidcConfig
    - getOidcConfig
    - redirectOidcLogin
    - oidcCallback
    - listExternalGroupOrgRoleMappings
    - updateExternalGroupOrgRoleMappings
    - requestEmailChangeOtp
    - activateUserMfa
    - addGatewayToPool
    - adminSignUp
    - attachAlicloudAuth
    - attachAwsAuth
    - attachAzureAuth
    - attachGcpAuth
    - attachJwtAuth
    - attachKubernetesAuth
    - attachLdapAuth
    - attachOciAuth
    - attachOidcAuth
    - attachSpiffeAuth
    - attachTlsCertAuth
    - attachTokenAuth
    - checkAuth
    - checkTotpMfa
    - clearLdapAuthLockouts
    - clearUniversalAuthLockouts
    - connectGateway
    - connectRelay
    - countMachineIdentitiesV2
    - createAdminEmailDomain
    - createAdminOrganization
    - createAlert
    - createAzureAuditLogStream
    - createCriblAuditLogStream
    - createCustomAuditLogStream
    - createDatadogAuditLogStream
    - createSplunkAuditLogStream
    - createSumoLogicAuditLogStream
    - createGateway
    - createGatewayPool
    - createIdentityAuthTemplate
    - createOrganizationIncidentContact
    - createOrganizationRole
    - createRelay
    - createSubOrganization
    - createSubOrganizationMembership
    - createTokenAuthToken
    - deactivateUserMfa
    - deleteAdminEmailDomain
    - deleteAdminOrganization
    - deleteAdminOrganizationMembership
    - deleteAdminUser
    - deleteAdminUsers
    - deleteAlert
    - deleteAlicloudAuth
    - deleteAwsAuth
    - deleteAzureAuth
    - deleteCustomAuditLogStream
    - deleteEmailDomain
    - deleteGateway
    - deleteGatewayPool
    - deleteGcpAuth
    - deleteIdentityAuthTemplate
    - deleteIdentityAuthTemplateUsage
    - deleteJwtAuth
    - deleteKubernetesAuth
    - deleteLdapAuth
    - deleteOciAuth
    - deleteOidcAuth
    - deleteOrganizationIncidentContact
    - deleteOrganizationRole
    - deleteRelay
    - deleteSpiffeAuth
    - deleteSubOrganization
    - deleteTlsCertAuth
    - deleteTokenAuth
    - deleteUniversalAuth
    - deleteUserNotification
    - deleteUserNotifications
    - deleteUserTotpConfig
    - enableEmailAuthForUser
    - gatewayHeartbeat
    - gatewayMetricsReport
    - getAdminConfig
    - getAlertById
    - getAlicloudAuth
    - getAwsAuth
    - getAzureAuth
    - getCurrentUserV1
    - getAzureAuditLogStream
    - getCriblAuditLogStream
    - getCustomAuditLogStream
    - getDatadogAuditLogStream
    - getSplunkAuditLogStream
    - getSumoLogicAuditLogStream
    - getGateway
    - getGatewayConnectedResources
    - getGatewayPoolById
    - getGatewayPoolConnectedResources
    - getGcpAuth
    - getIdentityAuthTemplate
    - getIdentityAuthTemplateUsage
    - getJwtAuth
    - getKubernetesAuth
    - getLdapAuth
    - getMfaSessionStatus
    - getOciAuth
    - getOidcAuth
    - getOidcIssuerDiscoveryDocument
    - getOidcIssuerJwks
    - getOrganizationAuditLogPostgresStorageStatus
    - getOrganizationPermissions
    - getOrganizationRoleById
    - getOrganizationRoleBySlug
    - getRelay
    - getRelays
    - getSpiffeAuth
    - getTlsCertAuth
    - getTokenAuth
    - getTokenAuthTokenById
    - getTokenAuthTokenByIdDeprecated
    - getTokenAuthTokens
    - getUniversalAuth
    - getUniversalAuthClientSecret
    - getUserMfaRecoveryCodes
    - getUserTotpConfig
    - githubLoginCallback
    - gitlabLoginCallback
    - googleLoginCallback
    - grantAdminAccessToUser
    - heartbeatInstanceRelay
    - heartbeatOrgRelay
    - joinAdminOrganization
    - listAdminEmailDomains
    - listAdminIdentities
    - listAdminOrganizations
    - listAdminUsers
    - listAlerts
    - listAuditLogStreamOptions
    - listAuditLogStreams
    - listAvailableProjectUsers
    - listGatewayPools
    - listGateways
    - listIdentityAuthTemplates
    - listOrganizationIncidentContacts
    - listOrganizationRoles
    - listOrganizationUserAccess
    - listOrganizations
    - listRelayGateways
    - listSubOrganizations
    - listUniversalAuthClientSecrets
    - listUserGroups
    - listUserNotifications
    - listUserOrganizations
    - listUserSessions
    - loginGateway
    - loginRelay
    - loginWithAlicloudAuth
    - loginWithAwsAuth
    - loginWithAzureAuth
    - loginWithGcpAuth
    - loginWithJwtAuth
    - loginWithKubernetesAuth
    - loginWithLdapAuth
    - loginWithOciAuth
    - loginWithOidcAuth
    - loginWithSpiffeAuth
    - loginWithTlsCertAuth
    - logout
    - markUserNotificationsAsRead
    - mintGatewayEnrollmentToken
    - mintRelayEnrollmentToken
    - redirectGitHubSSO
    - redirectGitLabSSO
    - redirectGoogleSSO
    - refreshSpiffeBundle
    - regenerateUserMfaRecoveryCodes
    - registerGateway
    - registerInstanceRelay
    - registerOrgRelay
    - registerUserTotp
    - relayHeartbeat
    - removeGatewayFromPool
    - renewIdentityAccessToken
    - resendAdminOrganizationInvite
    - resendMfaToken
    - resendOrganizationMemberInvitation
    - resetPassword
    - resetUserPassword
    - revokeAdminAccessFromUser
    - revokeAllUserSessions
    - revokeGatewayAccess
    - revokeIdentityAccessToken
    - revokeIdentitySuperAdminAccess
    - revokeRelayAccess
    - revokeTokenAuthToken
    - revokeUniversalAuthClientSecret
    - revokeUserSession
    - searchIdentityAuthTemplates
    - searchMachineIdentitiesV2
    - sendAccountRecoveryEmail
    - sendEmailVerificationCode
    - sendPasswordSetupEmail
    - setupPassword
    - testAlertChannel
    - triggerGatewayHeartbeat
    - unlockUser
    - updateAlert
    - updateAlicloudAuth
    - updateAwsAuth
    - updateAzureAuth
    - updateCustomAuditLogStream
    - updateGateway
    - updateGatewayPool
    - updateGcpAuth
    - updateIdentityAuthTemplate
    - updateJwtAuth
    - updateKubernetesAuth
    - updateLdapAuth
    - updateOciAuth
    - updateOidcAuth
    - updateOrganizationRole
    - updateRelay
    - updateSpiffeAuth
    - updateSubOrganization
    - updateTlsCertAuth
    - updateTokenAuth
    - updateTokenAuthToken
    - updateUniversalAuth
    - updateUserAuthMethods
    - updateUserEmail
    - updateUserMfaMethod
    - updateUserName
    - updateUserNotification
    - verifyAccountRecoveryEmail
    - verifyCurrentEmailOtp
    - verifyMfa
    - verifyMfaRecoveryCode
    - verifyMfaSession
    - verifyUserTotpConfig
    - enrollUserMfa
    - loginWithLdapSso
    - getLdapConfig
    - createLdapConfig
    - updateLdapConfig
    - listLdapGroupMaps
    - createLdapGroupMap
    - deleteLdapGroupMap
    - testLdapConnection
    - createExternalKms
    - updateExternalKms
    - deleteExternalKms
    - getExternalKmsById
    - listExternalKms
    - getExternalKmsByName
    - createAwsExternalKms
    - getAwsExternalKms
    - updateAwsExternalKms
    - deleteAwsExternalKms
    - createGithubOrgSyncConfig
    - updateGithubOrgSyncConfig
    - deleteGithubOrgSyncConfig
    - getGithubOrgSyncConfig
    - syncAllGithubOrgTeams
    - listWorkflowIntegrations
    - listSlackIntegrations
    - getSlackInstallUrl
    - getSlackIntegration
    - deleteSlackIntegration
    - listMicrosoftTeamsIntegrations
    - getMicrosoftTeamsClientId
    - createAzureKeyVaultAppConnection
    - updateAzureKeyVaultAppConnection
    - deleteAzureKeyVaultAppConnection