The identity and technical contract details declared by the specification.
CaConfig
object
2 properties
AccessRoles
string
Roles of a user.
AuthConfigPassword
object
Configuration for password-based authentication.
2 properties
2 required
TlsConfigRequired
object
4 properties
2 required
AccountRequest
object
5 properties
1 required
AccountUpdateRequest
object
10 properties
AzureCvmPcrPriority
array
Ordered list of exactly the integer elements 0 through 22
AuthConfigRef
object
1 property
1 required
AuthConfigOauth
object
9 properties
8 required
AuthenticationConfig
object
3 properties
NodeEnrollment
object
1 property
1 required
Account
object
14 properties
3 required
UserAccountStatus
string
Status of an Account for a user.
TlsConfig
object
3 properties
AccountListResponse
object
1 property
ObjectCounts
object
3 properties
3 required
AccountComponent
string
Get the account type.
FpeDate
A structure for specifying a token part representing a date that occurs after a specified date and/or occurs before a specified date. Depending on the subparts…
FpeDataPart
Structure for specifying (part of) a complex tokenization data type.
AccountPurpose
Describes the purpose of the account.
NotificationPref
string
Notification preferences.
CipherMode
string
Cipher mode used for symmetric key algorithms.
CountAccuracy
An indicator of how accurate a count of objects is.
AccountPurposeTypeVariantAccountReplication
TlsConfigVariantOpportunistic
AccountReplicationScanSettings
FpeInputProcessing
Options to apply some pre- and post-processing to the input.
RemovableKmipClientConfig
SplunkLoggingConfigRequest
ReplicationCredentialVariantCertificate
AccountPurposeVariantAccountReplication
ApprovalRequestSettingsRequest
FpeInputProcessingPassthroughSpecific
UpdateReplicationCredentialRequestVariantCertificate
AccountPurposeTypeVariantStandard
CertificateReplicationCredential
LdapRoleConflictResolution
string
Controls how we resolve conflicting role assignments with LDAP authorization. When users are authorized through LDAP, their DSM group memberships are determine…
WorkspaceCseIdentityProvider
LdapUserSelfProvisioningConfig
MetadataStringConstraintRequired
FpeOptions
FPE-specific options (for specifying the format of the data to be encrypted)
AzureLogIngestionLoggingConfigRequest
LegacyUserAccountRole
string
Legacy user account role
UserAccountFlag
string
User account flag
LdapUserSelfProvisioningRole
A structure indicating how self-provisioned LDAP users will be assigned account roles.
ClientConfigurationsRequest
AccountReplicationConfiguration
AzureLogIngestionLoggingConfig
ReplicationCredential
Details about the admin app credential used to replicate objects from the source account.
SubscriptionType
Type of subscription.
All
string
A helper enum with a single variant, All, which indicates that something should apply to an entire part. (This is here mainly to allow other untagged enums to…
WorkspaceCseAuthorizationProvider
FpeWords
A set of fixed-length strings.
CountAccuracyVariantExact
MetadataDurationConstraint
RsaEncryptionPaddingPolicy
RSA encryption padding policy.
SigningKeys
Signing keys used to validate JSON Web Signature objects including signed JSON Web Tokens.
RsaSignaturePaddingPolicyPss
ReplicationCredentialSelfSignedCertRequest
FpePreserveMask
A structure indicating which indices in an encrypted part to mask or preserve.
RsaEncryptionPaddingPolicyOaep
RemovableWorkspaceCseConfig
AccountReplicationConnection
ObjectTypeFilterSelection
LdapDnResolutionVariantUserPrincipalName
CreateReplicationCredentialRequestVariantCertificate
RemovablePkcs11ClientConfig
SyslogLoggingConfigRequest
RemovableCommonClientConfig
AccountPurposeVariantStandard
FpeCharSet
The alphabet to use for an encrypted portion of a complex tokenization data type. Characters should be specified as a list of pairs, where each pair [a, b] rep…
EllipticCurve
string
Identifies a standardized elliptic curve.
SubscriptionChangeRequest
OauthAuthenticationParameters
KeyExpiryAlertTriggerVariantDaysAhead
AzureLogAnalyticsLoggingConfigRequest
ClientFileLoggingVariantDisabled
RsaSignaturePaddingPolicy
RSA signature padding policy.
LdapDnResolutionConstruct
FpeDatePart
string
Possible date-related constraint types that do not form a complete date (by themselves) for a complex tokenization data type.
CustomAttributeSearchMetadata
LdapDnResolutionVariantSearchByMail
SubscriptionFeatures
string
Features in subscription TOKENIZATION: HMG: AWSBYOK: AZUREBYOK: GCPBYOK: GCPEKMCONTROLPLANE: OCIBYOK:
SigningKeysVariantFetched
KeyOperations
string
Operations allowed to be performed on a given key. SIGN: If this is set, the key can be used to for signing. VERIFY: If this is set, the key can used for verif…
RemovablePluginCodeSigningPolicy
StackdriverLoggingConfigRequest
LdapDnResolution
Distinguished Name (DN) resolution method. Given a user's email address, a DN resolution method is used to find the user's DN in an LDAP directory.
ReplicationCredentialSelfSignedCertResponse
CaSet_2
string
Predefined CA sets.
ObjectTypeFilterVariantAll
KeyExpiryAlertConfigRequest
ListReplicationCredentialsResponse
LdapUserSelfProvisioningRoleVariantFixed
WorkspaceCseAuthMethod
string
Authentication method for Google Workspace CSE, User (default choice) requires each CSE user to be registered as a DSM user, while App requires each CSE user t…
FpeConstraintsApplicability
A structure indicating which subparts to which to apply a set of constraints.
FpeDateConstraint
Possible date-related constraint types for a portion of a complex tokenization data type.
ReplicationCredentialId
The ID of a replication credential.
RemovableCryptographicPolicy
UserAccountFlags
User's role(s) and state in an account.
SubscriptionExperimentalFeatures
UpdateCertificateReplicationCredentialRequest
OauthAuthParamDisplay
string
Corresponds to the display parameter in https://openid.net/specs/openid-connect-core-10.htmlAuthRequest
ClientFileLoggingVariantEnabled
OauthAuthParamPrompt
string
Corresponds to the prompt parameter in https://openid.net/specs/openid-connect-core-10.htmlAuthRequest
CreateReplicationCredentialRequest
A request to create a new admin app credential for account replication purposes. Note that the result is not immediately usable; further steps are needed in or…
CountAccuracyVariantApproximate
FpeCompoundPart
Structure of a compound portion of a complex tokenization data type, itself composed of smaller parts.
AzureLogAnalyticsLoggingConfig
UserAccountFlagOrRole
User account flag or legacy user account role name or custom role id
CredentialId
A wrapper type to provide better clarity that the id referenced is an integration credential object.
DigestAlgorithm
string
A hash algorithm.
ObjectType
string
Type of security object.
UpdateReplicationCredentialRequest
A request to update a replication credential (e.g., associating it with an app ID). Note that changing the credential from one type to another is disallowed; u…
ObjectTypeFilterVariantSelection
FpeTokenizeMode
string
How to tokenize a given input. The most secure option is "PreserveFormat".
FpeInputDefaultProcessing
string
LdapUserSelfProvisioningRoleFixed
TlsConfig_2
TLS client settings.
RemovableKeyHistoryPolicy
MetadataDurationConstraintRequired
KeyExpiryAlertSiemToolConfig
RemovableKeyMetadataPolicy
LdapDnResolutionVariantConstruct
AccountPurposeType
The purpose of the account (minus any configuration-related details).
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Fortanix publishes across the network.