package
2.0.13
Repository: https://github.com/antimatterhq/go-client.git
Documentation: pkg.go.dev

# Functions

LabelerFromContext retrieves the Labeler from the provided context, if present.
NewAntimatterDelegatedAWSKeyInfoKeyInfosKeyInformation returns new KeyInfosKeyInformation from AntimatterDelegatedAWSKeyInfo.
NewAntimatterDelegatedAzureKeyInfoKeyInfosKeyInformation returns new KeyInfosKeyInformation from AntimatterDelegatedAzureKeyInfo.
NewAntimatterDelegatedGCPKeyInfoKeyInfosKeyInformation returns new KeyInfosKeyInformation from AntimatterDelegatedGCPKeyInfo.
NewAvailableDelegatedRootEncryptionKeyProviderAvailableRootEncryptionKeyProvidersProvidersItem returns new AvailableRootEncryptionKeyProvidersProvidersItem from AvailableDelegatedRootEncryptionKeyProvider.
NewAvailableServiceAccountRootEncryptionKeyProviderAvailableRootEncryptionKeyProvidersProvidersItem returns new AvailableRootEncryptionKeyProvidersProvidersItem from AvailableServiceAccountRootEncryptionKeyProvider.
NewAWSServiceAccountKeyInfoKeyInfosKeyInformation returns new KeyInfosKeyInformation from AWSServiceAccountKeyInfo.
NewAzureServiceAccountKeyInfoKeyInfosKeyInformation returns new KeyInfosKeyInformation from AzureServiceAccountKeyInfo.
NewBYOKKeyInfoKeyInfosKeyInformation returns new KeyInfosKeyInformation from BYOKKeyInfo.
NewClient initializes new Client defined by OAS.
NewDomainIdentityAPIKeyPrincipalParamsDomainIdentityPrincipalDetails returns new DomainIdentityPrincipalDetails from DomainIdentityAPIKeyPrincipalParams.
NewDomainIdentityEmailPrincipalParamsDomainIdentityPrincipalDetails returns new DomainIdentityPrincipalDetails from DomainIdentityEmailPrincipalParams.
NewDomainIdentityHostedDomainPrincipalParamsDomainIdentityPrincipalDetails returns new DomainIdentityPrincipalDetails from DomainIdentityHostedDomainPrincipalParams.
NewDomainIdentityTenantIDPrincipalParamsDomainIdentityPrincipalDetails returns new DomainIdentityPrincipalDetails from DomainIdentityTenantIDPrincipalParams.
NewGCPServiceAccountKeyInfoKeyInfosKeyInformation returns new KeyInfosKeyInformation from GCPServiceAccountKeyInfo.
NewOptAccessLogEntryCreateInfo returns new OptAccessLogEntryCreateInfo with value set to v.
NewOptAccessLogEntryOpenInfo returns new OptAccessLogEntryOpenInfo with value set to v.
NewOptAccessLogEntryReadInfo returns new OptAccessLogEntryReadInfo with value set to v.
NewOptAntimatterDelegatedAWSKeyInfoProviderName returns new OptAntimatterDelegatedAWSKeyInfoProviderName with value set to v.
NewOptAntimatterDelegatedAzureKeyInfoProviderName returns new OptAntimatterDelegatedAzureKeyInfoProviderName with value set to v.
NewOptAntimatterDelegatedGCPKeyInfoProviderName returns new OptAntimatterDelegatedGCPKeyInfoProviderName with value set to v.
NewOptAPIKeyDomainIdentityProviderDetails returns new OptAPIKeyDomainIdentityProviderDetails with value set to v.
NewOptAvailableDelegatedRootEncryptionKeyProviderType returns new OptAvailableDelegatedRootEncryptionKeyProviderType with value set to v.
NewOptAvailableServiceAccountRootEncryptionKeyProviderType returns new OptAvailableServiceAccountRootEncryptionKeyProviderType with value set to v.
NewOptAWSServiceAccountKeyInfoProviderName returns new OptAWSServiceAccountKeyInfoProviderName with value set to v.
NewOptAzureServiceAccountKeyInfoProviderName returns new OptAzureServiceAccountKeyInfoProviderName with value set to v.
NewOptBool returns new OptBool with value set to v.
NewOptBYOKKeyInfoProviderName returns new OptBYOKKeyInfoProviderName with value set to v.
NewOptCapabilityReference returns new OptCapabilityReference with value set to v.
NewOptCapabilityRule returns new OptCapabilityRule with value set to v.
NewOptDataPolicyBindingInfoPeerDefault returns new OptDataPolicyBindingInfoPeerDefault with value set to v.
NewOptDataPolicyBindingInfoReadContextsItemPeerConfiguration returns new OptDataPolicyBindingInfoReadContextsItemPeerConfiguration with value set to v.
NewOptDataPolicyRuleTokenFormat returns new OptDataPolicyRuleTokenFormat with value set to v.
NewOptDataPolicyRuleTokenScope returns new OptDataPolicyRuleTokenScope with value set to v.
NewOptDateTime returns new OptDateTime with value set to v.
NewOptDomainID returns new OptDomainID with value set to v.
NewOptDomainIdentityAPIKeyPrincipalParamsType returns new OptDomainIdentityAPIKeyPrincipalParamsType with value set to v.
NewOptDomainIdentityEmailPrincipalParamsType returns new OptDomainIdentityEmailPrincipalParamsType with value set to v.
NewOptDomainIdentityHostedDomainPrincipalParamsType returns new OptDomainIdentityHostedDomainPrincipalParamsType with value set to v.
NewOptDomainIdentityProviderDetails returns new OptDomainIdentityProviderDetails with value set to v.
NewOptDomainIdentityTenantIDPrincipalParamsType returns new OptDomainIdentityTenantIDPrincipalParamsType with value set to v.
NewOptFactTypeReference returns new OptFactTypeReference with value set to v.
NewOptGCPServiceAccountKeyInfoProviderName returns new OptGCPServiceAccountKeyInfoProviderName with value set to v.
NewOptGoogleOAuthDomainIdentityProviderDetails returns new OptGoogleOAuthDomainIdentityProviderDetails with value set to v.
NewOptGoogleOAuthDomainIdentityProviderDetailsGroupMappings returns new OptGoogleOAuthDomainIdentityProviderDetailsGroupMappings with value set to v.
NewOptIdentityProviderName returns new OptIdentityProviderName with value set to v.
NewOptImportAlias returns new OptImportAlias with value set to v.
NewOptInt returns new OptInt with value set to v.
NewOptInt32 returns new OptInt32 with value set to v.
NewOptLLMClassifierConfig returns new OptLLMClassifierConfig with value set to v.
NewOptLogEntryID returns new OptLogEntryID with value set to v.
NewOptMicrosoftOAuthDomainIdentityProviderDetails returns new OptMicrosoftOAuthDomainIdentityProviderDetails with value set to v.
NewOptNewDataPolicyRuleAssignPriority returns new OptNewDataPolicyRuleAssignPriority with value set to v.
NewOptNewDataPolicyRuleTokenFormat returns new OptNewDataPolicyRuleTokenFormat with value set to v.
NewOptNewDataPolicyRuleTokenScope returns new OptNewDataPolicyRuleTokenScope with value set to v.
NewOptQueryCapsulesSortOn returns new OptQueryCapsulesSortOn with value set to v.
NewOptQueryOperationType returns new OptQueryOperationType with value set to v.
NewOptReadContextDetailsAttachedPoliciesItemStatus returns new OptReadContextDetailsAttachedPoliciesItemStatus with value set to v.
NewOptReadContextDetailsAttachedPoliciesItemStatusSource returns new OptReadContextDetailsAttachedPoliciesItemStatusSource with value set to v.
NewOptRegexClassifierConfig returns new OptRegexClassifierConfig with value set to v.
NewOptRootEncryptionKeyReference returns new OptRootEncryptionKeyReference with value set to v.
NewOptRuleID returns new OptRuleID with value set to v.
NewOptString returns new OptString with value set to v.
NewOptTagNamePattern returns new OptTagNamePattern with value set to v.
NewOptTagValueField returns new OptTagValueField with value set to v.
NewOptWorkspaceObjectApproval returns new OptWorkspaceObjectApproval with value set to v.
NewOptWorkspaceObjectDelegationPacket returns new OptWorkspaceObjectDelegationPacket with value set to v.
NewOptWorkspaceObjectKeychainInfo returns new OptWorkspaceObjectKeychainInfo with value set to v.
NewOptWorkspaceObjectRequest returns new OptWorkspaceObjectRequest with value set to v.
NewOptWriteContextName returns new OptWriteContextName with value set to v.
NewOptWriteContextReference returns new OptWriteContextReference with value set to v.
NewServer creates new Server.
WithClient specifies http client to use.
WithErrorHandler specifies error handler to use.
WithMaxMultipartMemory specifies limit of memory for storing file parts.
WithMeterProvider specifies a meter provider to use for creating a meter.
WithMethodNotAllowed specifies Method Not Allowed handler to use.
WithMiddleware specifies middlewares to use.
WithNotFound specifies Not Found handler to use.
WithPathPrefix specifies server path prefix.
WithServerURL sets context key to override server URL.
WithTracerProvider specifies a tracer provider to use for creating a tracer.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
Possible values for KeyInfosKeyInformationType.
No description provided by the author
Possible values for KeyInfosKeyInformationType.
No description provided by the author
Possible values for KeyInfosKeyInformationType.
No description provided by the author
Possible values for AvailableRootEncryptionKeyProvidersProvidersItemType.
No description provided by the author
Possible values for AvailableRootEncryptionKeyProvidersProvidersItemType.
No description provided by the author
Possible values for KeyInfosKeyInformationType.
No description provided by the author
Possible values for KeyInfosKeyInformationType.
No description provided by the author
Possible values for KeyInfosKeyInformationType.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Possible values for DomainIdentityPrincipalDetailsType.
No description provided by the author
Possible values for DomainIdentityPrincipalDetailsType.
No description provided by the author
Possible values for DomainIdentityPrincipalDetailsType.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Possible values for DomainIdentityPrincipalDetailsType.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Possible values for KeyInfosKeyInformationType.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

An individual capsule data-plane log entry.
Information available if the operation is of type "create".
Information available if the operation is of type "open".
Information available if the operation is of type "read".
The results for a query of the capsule access log.
The stored key ID to use as the active root encryption key.
The results for an activate key query.
A request to add a capsule log entry.
A request to add read contexts.
Information for adding/updating a write context.
The details required to use an AWS KMS root encryption key that has been delegated to Antimatter's AWS account.
The details required to use an Azure HSM root encryption key that has been delegated to Antimatter's Azure account.
The details required to use an GCP Key root encryption key that has been delegated to Antimatter's GCP service account.
Detailed information about an API key identity provider.
Ref: #/components/schemas/AvailableDelegatedRootEncryptionKeyProvider.
Ref: #/components/schemas/AvailableRootEncryptionKeyProviders.
AvailableRootEncryptionKeyProvidersProvidersItem represents sum type.
Ref: #/components/schemas/AvailableServiceAccountRootEncryptionKeyProvider.
The AWS service account information and details required to use the provided AWS hosted encryption keys for cryptographic operations.
The Azure service account information and details required to access the Azure HSM for cryptographic operations.
Ref: #/components/schemas/BYOKKeyInfo.
A capability is attached to authenticated domain identities by an identity provider, and confers additional permissions upon the identity.
A capability is attached to authenticated domain identities by an identity provider, and confers additional permissions upon the identity.
A list of capability definitions.
Ref: #/components/schemas/CapabilityExpression.
A rule that refers to a domain identity capability.
No description provided by the author
The response for the creation of a new capsule.
CapsuleGetByIdMovedPermanently is response for CapsuleGetById operation.
CapsuleGetByIdParams is parameters of capsuleGetById operation.
A summary of the capsule.
List of capsules.
A request to open (decrypt) a capsule.
Contains key material for a capsule.
The material required for enacting read context configuration (e.g.
Information applied when sealing a capsule (marking it as complete).
Configuration for a classification hook.
Client implements OAS client.
Returned when attempting to delete a resource that is still in use by other resources.
Configuration options for creating a new subdomain.
Information about a data policy.
Ref: #/components/schemas/DataPolicyBindingInfo.
No description provided by the author
Ref: #/components/schemas/DataPolicyClause.
A list of data policies.
Ref: #/components/schemas/DataPolicyRule.
A summary of changes applied to a data policy.
A set of changes to apply to a data policy.
A request to classify PII in a batch of records.
No description provided by the author
No description provided by the author
A response from invoking a data tagging hook.
No description provided by the author
Ref: #/components/schemas/DeleteTags.
Ref: #/components/schemas/DisasterRecoverySettings.
Information about a domain.
DomainAddAccessLogEntryForbidden is response for DomainAddAccessLogEntry operation.
DomainAddAccessLogEntryOK is response for DomainAddAccessLogEntry operation.
DomainAddAccessLogEntryParams is parameters of domainAddAccessLogEntry operation.
DomainAddExternalRootEncryptionKeyParams is parameters of domainAddExternalRootEncryptionKey operation.
DomainAddPeerDomainParams is parameters of domainAddPeerDomain operation.
An object containing external credentials that can be transmuted into a domain identity token.
DomainAuthenticateParams is parameters of domainAuthenticate operation.
A domain identity token.
DomainContactIssueVerifyOK is response for DomainContactIssueVerify operation.
DomainContactIssueVerifyParams is parameters of domainContactIssueVerify operation.
Parameters to request new validation request.
DomainContactVerifyParams is parameters of domainContactVerify operation.
Results for a domain control log query.
The results for a query of the capsule access log.
DomainCreateCapsuleParams is parameters of domainCreateCapsule operation.
No description provided by the author
No description provided by the author
DomainCreateDataPolicyParams is parameters of domainCreateDataPolicy operation.
DomainCreatePolicyRuleParams is parameters of domainCreatePolicyRule operation.
DomainDataPolicyConfigureRulesParams is parameters of domainDataPolicyConfigureRules operation.
DomainDataPolicyRuleUpdateOK is response for DomainDataPolicyRuleUpdate operation.
DomainDataPolicyRuleUpdateParams is parameters of domainDataPolicyRuleUpdate operation.
DomainDataTaggingHookInvokeParams is parameters of domainDataTaggingHookInvoke operation.
DomainDataTaggingHookTestParams is parameters of domainDataTaggingHookTest operation.
No description provided by the author
DomainDeleteCapabilityOK is response for DomainDeleteCapability operation.
DomainDeleteCapabilityParams is parameters of domainDeleteCapability operation.
DomainDeleteCapsuleTagsOK is response for DomainDeleteCapsuleTags operation.
DomainDeleteCapsuleTagsParams is parameters of domainDeleteCapsuleTags operation.
DomainDeleteDataPolicyOK is response for DomainDeleteDataPolicy operation.
DomainDeleteDataPolicyParams is parameters of domainDeleteDataPolicy operation.
DomainDeleteDataPolicyRuleOK is response for DomainDeleteDataPolicyRule operation.
DomainDeleteDataPolicyRuleParams is parameters of domainDeleteDataPolicyRule operation.
DomainDeleteExternalRootEncryptionKeyOK is response for DomainDeleteExternalRootEncryptionKey operation.
DomainDeleteExternalRootEncryptionKeyParams is parameters of domainDeleteExternalRootEncryptionKey operation.
DomainDeleteFactByIDMethodNotAllowed is response for DomainDeleteFactByID operation.
DomainDeleteFactByIDOK is response for DomainDeleteFactByID operation.
DomainDeleteFactByIDParams is parameters of domainDeleteFactByID operation.
DomainDeleteFactByTupleMethodNotAllowed is response for DomainDeleteFactByTuple operation.
DomainDeleteFactByTupleOK is response for DomainDeleteFactByTuple operation.
DomainDeleteFactByTupleParams is parameters of domainDeleteFactByTuple operation.
DomainDeleteFactTypeOK is response for DomainDeleteFactType operation.
DomainDeleteFactTypeParams is parameters of domainDeleteFactType operation.
DomainDeleteIdentityProviderOK is response for DomainDeleteIdentityProvider operation.
DomainDeleteIdentityProviderParams is parameters of domainDeleteIdentityProvider operation.
DomainDeleteIdentityProviderPrincipalOK is response for DomainDeleteIdentityProviderPrincipal operation.
DomainDeleteIdentityProviderPrincipalParams is parameters of domainDeleteIdentityProviderPrincipal operation.
DomainDeletePeerOK is response for DomainDeletePeer operation.
DomainDeletePeerParams is parameters of domainDeletePeer operation.
DomainDeletePolicyRuleOK is response for DomainDeletePolicyRule operation.
DomainDeletePolicyRuleParams is parameters of domainDeletePolicyRule operation.
DomainDeleteReadContextOK is response for DomainDeleteReadContext operation.
DomainDeleteReadContextParams is parameters of domainDeleteReadContext operation.
DomainDeleteWriteContextClassifierRuleOK is response for DomainDeleteWriteContextClassifierRule operation.
DomainDeleteWriteContextClassifierRuleParams is parameters of domainDeleteWriteContextClassifierRule operation.
DomainDeleteWriteContextOK is response for DomainDeleteWriteContext operation.
DomainDeleteWriteContextParams is parameters of domainDeleteWriteContext operation.
DomainDeleteWriteContextRegexRuleOK is response for DomainDeleteWriteContextRegexRule operation.
DomainDeleteWriteContextRegexRuleParams is parameters of domainDeleteWriteContextRegexRule operation.
DomainDescribeWriteContextParams is parameters of domainDescribeWriteContext operation.
DomainExternalRootEncryptionKeyTestParams is parameters of domainExternalRootEncryptionKeyTest operation.
No description provided by the author
A list of defined fact types in the domain.
DomainFlushEncryptionKeysOK is response for DomainFlushEncryptionKeys operation.
DomainFlushEncryptionKeysParams is parameters of domainFlushEncryptionKeys operation.
No description provided by the author
DomainGetActiveExternalRootEncryptionKeyParams is parameters of domainGetActiveExternalRootEncryptionKey operation.
DomainGetCapabilitiesParams is parameters of domainGetCapabilities operation.
DomainGetCapabilityParams is parameters of domainGetCapability operation.
DomainGetCapsuleInfoParams is parameters of domainGetCapsuleInfo operation.
DomainGetDataPolicyBindingParams is parameters of domainGetDataPolicyBinding operation.
DomainGetDataPolicyParams is parameters of domainGetDataPolicy operation.
DomainGetDataPolicyRuleParams is parameters of domainGetDataPolicyRule operation.
DomainGetDisasterRecoverySettingsParams is parameters of domainGetDisasterRecoverySettings operation.
DomainGetEncryptionSettingsParams is parameters of domainGetEncryptionSettings operation.
DomainGetExternalRootEncryptionKeyParams is parameters of domainGetExternalRootEncryptionKey operation.
DomainGetExternalRootEncryptionKeyProvidersParams is parameters of domainGetExternalRootEncryptionKeyProviders operation.
DomainGetFactByIDParams is parameters of domainGetFactByID operation.
DomainGetFactTypeParams is parameters of domainGetFactType operation.
DomainGetIdentityGroupProvidersParams is parameters of domainGetIdentityGroupProviders operation.
DomainGetIdentityProviderParams is parameters of domainGetIdentityProvider operation.
DomainGetIdentityProviderPrincipalParams is parameters of domainGetIdentityProviderPrincipal operation.
DomainGetIdentityProviderPrincipalsParams is parameters of domainGetIdentityProviderPrincipals operation.
DomainGetPeerConfigParams is parameters of domainGetPeerConfig operation.
DomainGetPeerParams is parameters of domainGetPeer operation.
DomainGetPrivateInfoParams is parameters of domainGetPrivateInfo operation.
DomainGetPublicInfoParams is parameters of domainGetPublicInfo operation.
DomainGetReadContextParams is parameters of domainGetReadContext operation.
DomainGetSettingsParams is parameters of domainGetSettings operation.
DomainGetStatusParams is parameters of domainGetStatus operation.
DomainGetTagInfoParams is parameters of domainGetTagInfo operation.
DomainGetVendorSettingsParams is parameters of domainGetVendorSettings operation.
No description provided by the author
DomainGetWriteContextClassifierRulesParams is parameters of domainGetWriteContextClassifierRules operation.
No description provided by the author
DomainGetWriteContextRegexRulesParams is parameters of domainGetWriteContextRegexRules operation.
A list of available hooks in this domain.
No description provided by the author
No description provided by the author
Details for an API key principal.
Details for an email principal.
Information about an identity provider.
No description provided by the author
Additional details for a hosted domain principal.
Ref: #/components/schemas/DomainIdentityPrincipalDetails DomainIdentityPrincipalDetails represents sum type.
Ref: #/components/schemas/DomainIdentityProviderDetails.
Information about an identity provider.
A list of identity providers.
A list of principals in an identity provider.
Details to create a domain identity principal.
Additional details for a tenant ID principal.
No description provided by the author
DomainInsertIdentityProviderPrincipalParams is parameters of domainInsertIdentityProviderPrincipal operation.
No description provided by the author
DomainInsertWriteContextClassifierRuleParams is parameters of domainInsertWriteContextClassifierRule operation.
No description provided by the author
DomainInsertWriteContextRegexRuleParams is parameters of domainInsertWriteContextRegexRule operation.
DomainListCapsulesParams is parameters of domainListCapsules operation.
DomainListDataPoliciesParams is parameters of domainListDataPolicies operation.
DomainListExternalRootEncryptionKeyParams is parameters of domainListExternalRootEncryptionKey operation.
DomainListFactsParams is parameters of domainListFacts operation.
DomainListFactTypesParams is parameters of domainListFactTypes operation.
DomainListHooksParams is parameters of domainListHooks operation.
DomainListIdentityProvidersParams is parameters of domainListIdentityProviders operation.
DomainListPeersParams is parameters of domainListPeers operation.
DomainListPolicyRulesParams is parameters of domainListPolicyRules operation.
DomainListReadContextsParams is parameters of domainListReadContexts operation.
DomainListResourcesParams is parameters of domainListResources operation.
DomainListWriteContextsParams is parameters of domainListWriteContexts operation.
DomainOpenCapsuleParams is parameters of domainOpenCapsule operation.
Configuration of a domain peer.
Information about the domains that this domain is peered with.
No description provided by the author
A domain's policy.
DomainPolicyFlushOK is response for DomainPolicyFlush operation.
DomainPolicyFlushParams is parameters of domainPolicyFlush operation.
A rule governing the domain's policy.
Private information about a domain.
Public information about a domain.
DomainPutCapabilityOK is response for DomainPutCapability operation.
DomainPutCapabilityParams is parameters of domainPutCapability operation.
DomainPutDisasterRecoverySettingsOK is response for DomainPutDisasterRecoverySettings operation.
DomainPutDisasterRecoverySettingsParams is parameters of domainPutDisasterRecoverySettings operation.
DomainPutEncryptionSettingsOK is response for DomainPutEncryptionSettings operation.
DomainPutEncryptionSettingsParams is parameters of domainPutEncryptionSettings operation.
DomainPutFactTypeOK is response for DomainPutFactType operation.
DomainPutFactTypeParams is parameters of domainPutFactType operation.
DomainPutSettingsParams is parameters of domainPutSettings operation.
DomainPutVendorSettingsOK is response for DomainPutVendorSettings operation.
DomainPutVendorSettingsParams is parameters of domainPutVendorSettings operation.
DomainQueryAccessLogParams is parameters of domainQueryAccessLog operation.
DomainQueryAccessLogSingleCapsuleParams is parameters of domainQueryAccessLogSingleCapsule operation.
DomainQueryControlLogParams is parameters of domainQueryControlLog operation.
DomainRenumberDataPolicyRulesOK is response for DomainRenumberDataPolicyRules operation.
DomainRenumberDataPolicyRulesParams is parameters of domainRenumberDataPolicyRules operation.
DomainRenumberPolicyRulesParams is parameters of domainRenumberPolicyRules operation.
No description provided by the author
A list of the resources and permissions available.
No description provided by the author
DomainRotateRootEncryptionKeysParams is parameters of domainRotateRootEncryptionKeys operation.
No description provided by the author
DomainSealCapsuleOK is response for DomainSealCapsule operation.
DomainSealCapsuleParams is parameters of domainSealCapsule operation.
DomainSetActiveExternalRootEncryptionKeyParams is parameters of domainSetActiveExternalRootEncryptionKey operation.
DomainSetDataPolicyBindingOK is response for DomainSetDataPolicyBinding operation.
DomainSetDataPolicyBindingParams is parameters of domainSetDataPolicyBinding operation.
Additional configuration options for a domain.
Information about the status of the domain.
No description provided by the author
Ordered list of the top 100 tags.
DomainUpdateDataPolicyOK is response for DomainUpdateDataPolicy operation.
DomainUpdateDataPolicyParams is parameters of domainUpdateDataPolicy operation.
DomainUpdateIdentityProviderPrincipalOK is response for DomainUpdateIdentityProviderPrincipal operation.
DomainUpdateIdentityProviderPrincipalParams is parameters of domainUpdateIdentityProviderPrincipal operation.
DomainUpdatePeerOK is response for DomainUpdatePeer operation.
DomainUpdatePeerParams is parameters of domainUpdatePeer operation.
DomainUpdatePolicyRuleOK is response for DomainUpdatePolicyRule operation.
DomainUpdatePolicyRuleParams is parameters of domainUpdatePolicyRule operation.
DomainUpsertCapsuleTagsOK is response for DomainUpsertCapsuleTags operation.
DomainUpsertCapsuleTagsParams is parameters of domainUpsertCapsuleTags operation.
No description provided by the author
DomainUpsertFactParams is parameters of domainUpsertFact operation.
DomainUpsertIdentityProviderParams is parameters of domainUpsertIdentityProvider operation.
DomainUpsertReadContextOK is response for DomainUpsertReadContext operation.
DomainUpsertReadContextParams is parameters of domainUpsertReadContext operation.
DomainUpsertSpanTagsOK is response for DomainUpsertSpanTags operation.
DomainUpsertSpanTagsParams is parameters of domainUpsertSpanTags operation.
DomainUpsertWriteContextConfigurationOK is response for DomainUpsertWriteContextConfiguration operation.
DomainUpsertWriteContextConfigurationParams is parameters of domainUpsertWriteContextConfiguration operation.
DomainUpsertWriteContextOK is response for DomainUpsertWriteContext operation.
DomainUpsertWriteContextParams is parameters of domainUpsertWriteContext operation.
Encryption-related settings for a domain.
An internal error.
ErrorStatusCode wraps Error with StatusCode.
Information about a data policy, including its rules.
A fact is a piece of auxiliary information that can be used as part of an authorization policy.
Ref: #/components/schemas/FactExpression.
No description provided by the author
A list of facts.
No description provided by the author
No description provided by the author
A fact tuple contains the argument tuple for the provided fact type.
A type definition (schema) for a fact.
No description provided by the author
Returned when the server is forbidden from performing some action on the user's behalf by a third-party service (for example, AWS KMS).
The GCP service account information and details required to use the provided GCP hosted encryption key for cryptographic operations.
Detailed information about a Google OAuth identity provider.
No description provided by the author
A mapping of group membership to allocated capabilities.
The group capability mapping object containing both mappings and administrative configuration.
Returned when one of the identifiers or arguments in the request is invalid.
KeychainGetWorkspaceInfoParams is parameters of keychainGetWorkspaceInfo operation.
KeychainGetWorkspaceObjectsParams is parameters of keychainGetWorkspaceObjects operation.
KeychainPutWorkspaceObjectsOK is response for KeychainPutWorkspaceObjects operation.
KeychainPutWorkspaceObjectsParams is parameters of keychainPutWorkspaceObjects operation.
Holds the required service account information for varying providers.
KeyInfosKeyInformation represents sum type.
Labeler is used to allow adding custom attributes to the server request metrics.
Configuration settings for llm-classifier.
Detailed information about a Microsoft OAuth identity provider.
An individual capsule data-plane log entry, in the form required when inserting a new record.
Information available if the operation is of type "read".
A capability is attached to authenticated domain identities by an identity provider, and confers additional permissions upon the identity.
The configuration for a new data policy, with rules.
Ref: #/components/schemas/NewDataPolicyRule.
Parameters when creating a domain.
A rule governing the domain's policy.
Information returned from a successful domain create request.
Fields associated with a domain that are to be updated.
A fact is a piece of auxiliary information that can be used as part of an authorization policy.
A type definition (schema) for a fact being created.
No description provided by the author
Vendor settings for a domain.
Ref: #/components/schemas/NewWorkspace.
Ref: #/components/schemas/NewWorkspaceObjects.
No description provided by the author
OptAccessLogEntryCreateInfo is optional AccessLogEntryCreateInfo.
OptAccessLogEntryOpenInfo is optional AccessLogEntryOpenInfo.
OptAccessLogEntryReadInfo is optional AccessLogEntryReadInfo.
OptAntimatterDelegatedAWSKeyInfoProviderName is optional AntimatterDelegatedAWSKeyInfoProviderName.
OptAntimatterDelegatedAzureKeyInfoProviderName is optional AntimatterDelegatedAzureKeyInfoProviderName.
OptAntimatterDelegatedGCPKeyInfoProviderName is optional AntimatterDelegatedGCPKeyInfoProviderName.
OptAPIKeyDomainIdentityProviderDetails is optional APIKeyDomainIdentityProviderDetails.
OptAvailableDelegatedRootEncryptionKeyProviderType is optional AvailableDelegatedRootEncryptionKeyProviderType.
OptAvailableServiceAccountRootEncryptionKeyProviderType is optional AvailableServiceAccountRootEncryptionKeyProviderType.
OptAWSServiceAccountKeyInfoProviderName is optional AWSServiceAccountKeyInfoProviderName.
OptAzureServiceAccountKeyInfoProviderName is optional AzureServiceAccountKeyInfoProviderName.
OptBool is optional bool.
OptBYOKKeyInfoProviderName is optional BYOKKeyInfoProviderName.
OptCapabilityReference is optional CapabilityReference.
OptCapabilityRule is optional CapabilityRule.
OptDataPolicyBindingInfoPeerDefault is optional DataPolicyBindingInfoPeerDefault.
OptDataPolicyBindingInfoReadContextsItemPeerConfiguration is optional DataPolicyBindingInfoReadContextsItemPeerConfiguration.
OptDataPolicyRuleTokenFormat is optional DataPolicyRuleTokenFormat.
OptDataPolicyRuleTokenScope is optional DataPolicyRuleTokenScope.
OptDateTime is optional time.Time.
OptDomainID is optional DomainID.
OptDomainIdentityAPIKeyPrincipalParamsType is optional DomainIdentityAPIKeyPrincipalParamsType.
OptDomainIdentityEmailPrincipalParamsType is optional DomainIdentityEmailPrincipalParamsType.
OptDomainIdentityHostedDomainPrincipalParamsType is optional DomainIdentityHostedDomainPrincipalParamsType.
OptDomainIdentityProviderDetails is optional DomainIdentityProviderDetails.
OptDomainIdentityTenantIDPrincipalParamsType is optional DomainIdentityTenantIDPrincipalParamsType.
OptFactTypeReference is optional FactTypeReference.
OptGCPServiceAccountKeyInfoProviderName is optional GCPServiceAccountKeyInfoProviderName.
OptGoogleOAuthDomainIdentityProviderDetails is optional GoogleOAuthDomainIdentityProviderDetails.
OptGoogleOAuthDomainIdentityProviderDetailsGroupMappings is optional GoogleOAuthDomainIdentityProviderDetailsGroupMappings.
OptIdentityProviderName is optional IdentityProviderName.
OptImportAlias is optional ImportAlias.
OptInt is optional int.
OptInt32 is optional int32.
OptLLMClassifierConfig is optional LLMClassifierConfig.
OptLogEntryID is optional LogEntryID.
OptMicrosoftOAuthDomainIdentityProviderDetails is optional MicrosoftOAuthDomainIdentityProviderDetails.
OptNewDataPolicyRuleAssignPriority is optional NewDataPolicyRuleAssignPriority.
OptNewDataPolicyRuleTokenFormat is optional NewDataPolicyRuleTokenFormat.
OptNewDataPolicyRuleTokenScope is optional NewDataPolicyRuleTokenScope.
OptQueryCapsulesSortOn is optional QueryCapsulesSortOn.
OptQueryOperationType is optional QueryOperationType.
OptReadContextDetailsAttachedPoliciesItemStatus is optional ReadContextDetailsAttachedPoliciesItemStatus.
OptReadContextDetailsAttachedPoliciesItemStatusSource is optional ReadContextDetailsAttachedPoliciesItemStatusSource.
OptRegexClassifierConfig is optional RegexClassifierConfig.
OptRootEncryptionKeyReference is optional RootEncryptionKeyReference.
OptRuleID is optional RuleID.
OptString is optional string.
OptTagNamePattern is optional TagNamePattern.
OptTagValueField is optional TagValueField.
OptWorkspaceObjectApproval is optional WorkspaceObjectApproval.
OptWorkspaceObjectDelegationPacket is optional WorkspaceObjectDelegationPacket.
OptWorkspaceObjectKeychainInfo is optional WorkspaceObjectKeychainInfo.
OptWorkspaceObjectRequest is optional WorkspaceObjectRequest.
OptWriteContextName is optional WriteContextName.
OptWriteContextReference is optional WriteContextReference.
Ref: #/components/responses/PermanentRedirect.
Returned when the server is unable to process the request due to a failed precondition.
Detailed information about a principal.
Ref: #/components/schemas/PrincipalSummary.
Details about a read context.
No description provided by the author
A list of read contexts.
Declare parameters that can be passed in for use in read context configuration rules.
Ref: #/components/schemas/ReadContextRequiredHook.
Abridged details about a read context.
An instance of a read context parameter, passed in during capsule open.
Ref: #/components/schemas/ReadParameterExpression.
Configuration settings for regex-classifier.
Returned when the server is unable to process the request due to resource exhaustion or rate limiting.
Returned when interacting with a valid URL, but the request references an unknown resource.
The newly created root encryption key's ID.
Ref: #/components/schemas/RootEncryptionKeyItem.
Ref: #/components/schemas/RootEncryptionKeyListResponse.
Ref: #/components/schemas/RootEncryptionKeyTestResponse.
The results for a rotation query.
Route is route object.
Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.
Ref: #/components/schemas/SetDataPolicyBinding.
No description provided by the author
StarredDomainAddOK is response for StarredDomainAdd operation.
StarredDomainAddParams is parameters of starredDomainAdd operation.
No description provided by the author
Ref: #/components/schemas/StarredDomainList.
StarredDomainRemoveOK is response for StarredDomainRemove operation.
StarredDomainRemoveParams is parameters of starredDomainRemove operation.
Ref: #/components/schemas/Tag.
Ref: #/components/schemas/TagExpression.
Ref: #/components/schemas/TagMeta.
Ref: #/components/schemas/TagSet.
No description provided by the author
Ref: #/components/schemas/TagSummary.
No description provided by the author
No description provided by the author
Returned when the server cannot authorize the request.
UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.
New principal settings to apply to principal.
Ref: #/components/schemas/UpsertSpanTagsRequest.
Ref: #/components/schemas/VariableDefinition.
No description provided by the author
Vendor settings for a domain.
Returned by successful contact email verification.
Ref: #/components/schemas/WorkspaceInfo.
Ref: #/components/schemas/WorkspaceObject.
No description provided by the author
No description provided by the author
No description provided by the author
A list of objects from a workspace.
No description provided by the author
Tag descriptor for a write context regex rule.
Information about write context config rules.
No description provided by the author
Details about a write context.
A list of write contexts.
Regex classifier rule for a write context.

# Interfaces

No description provided by the author
ClientOption is client config option.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Handler handles operations described by OpenAPI v3 specification.
Invoker invokes operations described by OpenAPI v3 specification.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Option is config option.
SecurityHandler is handler for security parameters.
SecuritySource is provider of security values (tokens, passwords, etc.).
ServerOption is server config option.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
The client-specified parameters representing the user on whose behalf this read is being carried out.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AvailableRootEncryptionKeyProvidersProvidersItemType is oneOf type of AvailableRootEncryptionKeyProvidersProvidersItem.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
What is our default binding? For imported policies, this defaults to Inherit, for our own policies this defaults to NotAttached.
If this is an imported policy, what is the peer's default binding config for it?.
This is the configuration of this policy binding in our domain.
This is the configuration of this policy binding in the peer domain (for imported policies).
This defines where the status is coming from.
This is the actual status of this binding, looking at our config, the peer config, and the actual availability of the policy.
No description provided by the author
No description provided by the author
The effect that is applied if a rule matches.
If the effect is Tokenize, what format should the token take.
If the effect is Tokenize, what scope to use for the token.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DomainIdentityPrincipalDetailsType is oneOf type of DomainIdentityPrincipalDetails.
Principal type supported by an identity provider.
No description provided by the author
No description provided by the author
No description provided by the author
Mapping from placeholder name to list of values.
No description provided by the author
ErrorHandler is error handler.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Which value to compare against.
Whether this assertion matches when the fact exists or does not exist.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
KeyInfosKeyInformationType is oneOf type of KeyInfosKeyInformation.
No description provided by the author
Middleware is middleware type.
No description provided by the author
The client-specified parameters representing the user on whose behalf this read is being carried out.
Automatically determines the rule's priority based on the priority numbers of rules already in the policy.
If the effect is Tokenize, what format should the token take.
If the effect is Tokenize, what scope to use for the token.
No description provided by the author
No description provided by the author
Ref: #/components/schemas/PolicyRuleOperation.
Ref: #/components/schemas/PolicyRuleResult.
No description provided by the author
No description provided by the author
No description provided by the author
This is the actual status of this binding, looking at our config, the peer config, and the actual availability of the policy.
This defines why the policy has the above status.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The type of this tag.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
How should this hook be invoked.
No description provided by the author
No description provided by the author