Post
/crypto/v1/agree
Perform a cryptographic key agreement operation between a public key and a private key. Both keys must have been generated from the same parameters (e.g. the same elliptic curve). Both keys must allow the AGREEKEY operation. The request body contains the requested properties for the new key as well as the mechanism (e.g. Diffie-Hellman) to be used to produce the key material for the new key. The output of this API should not be used directly as a cryptographic key. The target object type should be HMAC or Secret, and a key derivation procedure should be used to derive the actual key material.
Security
HTTP
Type bearer
API Key
Header parameter nameAuthorization
Body parameters
object
activation_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
deactivation_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
private_key
OneOf
SobjectDescriptorVariantKid
object (SobjectDescriptorVariantKid)
kid
string (uuid) Required
SobjectDescriptorVariantName
object (SobjectDescriptorVariantName)
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
SobjectDescriptorVariantTransientKey
object (SobjectDescriptorVariantTransientKey)
transient_key
string (byte) Required
SobjectDescriptorVariantInline
object (SobjectDescriptorVariantInline)
inline
object Required
value
string (byte) Required
obj_type
string Required
Valid values[
"AES",
"ARIA",
"DES",
"DES3",
"SEED",
"RSA",
"DSA",
"EC",
"KCDSA",
"ECKCDSA",
"BIP32",
"BLS",
"OPAQUE",
"HMAC",
"LEDABETA",
"ROUND5BETA",
"SECRET",
"LMS",
"XMSS",
"MLDSA",
"MLDSABETA",
"MLKEM",
"MLKEMBETA",
"CERTIFICATE",
"PBE"
]
public_key
OneOf
SobjectDescriptorVariantKid
object (SobjectDescriptorVariantKid)
kid
string (uuid) Required
SobjectDescriptorVariantName
object (SobjectDescriptorVariantName)
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
SobjectDescriptorVariantTransientKey
object (SobjectDescriptorVariantTransientKey)
transient_key
string (byte) Required
SobjectDescriptorVariantInline
object (SobjectDescriptorVariantInline)
inline
object Required
value
string (byte) Required
obj_type
string Required
Valid values[
"AES",
"ARIA",
"DES",
"DES3",
"SEED",
"RSA",
"DSA",
"EC",
"KCDSA",
"ECKCDSA",
"BIP32",
"BLS",
"OPAQUE",
"HMAC",
"LEDABETA",
"ROUND5BETA",
"SECRET",
"LMS",
"XMSS",
"MLDSA",
"MLDSABETA",
"MLKEM",
"MLKEMBETA",
"CERTIFICATE",
"PBE"
]
mechanism
string Required
Valid values[
"diffie_hellman"
]
name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
group_id
string (uuid) | null
key_type
string Required
Valid values[
"AES",
"ARIA",
"DES",
"DES3",
"SEED",
"RSA",
"DSA",
"EC",
"KCDSA",
"ECKCDSA",
"BIP32",
"BLS",
"OPAQUE",
"HMAC",
"LEDABETA",
"ROUND5BETA",
"SECRET",
"LMS",
"XMSS",
"MLDSA",
"MLDSABETA",
"MLKEM",
"MLKEMBETA",
"CERTIFICATE",
"PBE"
]
key_size
integer Required
Minimum0
Maximum4294967295
enabled
boolean | null
description
string | null
custom_metadata
object | null
property*
string additionalProperties
key_ops
Array of string | null
string
Valid values[
"SIGN",
"VERIFY",
"ENCRYPT",
"DECRYPT",
"WRAPKEY",
"UNWRAPKEY",
"DERIVEKEY",
"TRANSFORM",
"MACGENERATE",
"MACVERIFY",
"EXPORT",
"APPMANAGEABLE",
"HIGHVOLUME",
"AGREEKEY",
"ENCAPSULATE",
"DECAPSULATE"
]
state
string
Valid values[
"PreActive",
"Active",
"Deactivated",
"Compromised",
"Destroyed",
"Deleted"
]
transient
boolean | null
export_policy
allow_weakening
boolean Required
OneOf
object
object
$type
string Required
Valid values[
"Wrapped"
]
by
OneOf
object
object
$type
string Required
Valid values[
"Only"
]
keys
Array of object (SobjectDescriptorPersisted) Required
OneOf
SobjectDescriptorPersistedVariantKid
object (SobjectDescriptorPersistedVariantKid)
kid
string (uuid) Required
SobjectDescriptorPersistedVariantName
object (SobjectDescriptorPersistedVariantName)
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
object
object
$type
string Required
Valid values[
"Any"
]
object
object
$type
string Required
Valid values[
"Unrestricted"
]
Responses
2XX
Success result
object
acct_id
string (uuid)
activation_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
aes
object
key_sizes
Array of integer | null
integer
Minimum0
Maximum4294967295
fpe
OneOf
object
object
radix
integer
Minimum0
Maximum4294967295
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
preserve
Array of integer
integer (int64)
mask
Array of integer | null
integer (int64)
luhn_check
boolean | null
name
string | null
object
object
format
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
description
string | null
tag_length
integer (int32) | null
cipher_mode
string
Valid values[
"ECB",
"CBC",
"CBCNOPAD",
"CFB",
"OFB",
"CTR",
"GCM",
"CCM",
"KW",
"KWP",
"FF1"
]
random_iv
boolean | null
iv_length
integer (int32) | null
allow_sign_hash
boolean | null
aria
object
key_sizes
Array of integer | null
integer
Minimum0
Maximum4294967295
tag_length
integer | null
Minimum0
Maximum255
cipher_mode
string
Valid values[
"ECB",
"CBC",
"CBCNOPAD",
"CFB",
"OFB",
"CTR",
"GCM",
"CCM",
"KW",
"KWP",
"FF1"
]
random_iv
boolean | null
iv_length
integer | null
Minimum0
Maximum255
bip32
object
derivation_path
Array of integer | null
integer
Minimum0
Maximum4294967295
network
string
Valid values[
"mainnet",
"testnet"
]
bls
object
variant
string
Valid values[
"small_signatures",
"small_public_keys"
]
compliant_with_policies
boolean | null
compromise_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
creator
OneOf
PrincipalVariantApp
object (PrincipalVariantApp)
app
string (uuid)
PrincipalVariantUser
object (PrincipalVariantUser)
user
string (uuid)
PrincipalVariantPlugin
object (PrincipalVariantPlugin)
plugin
string (uuid)
PrincipalVariantUserViaApp
object (PrincipalVariantUserViaApp)
userviaapp
object
user_id
string (uuid)
scopes
Array of string (OauthScope)
string
Valid values[
"app",
"openid",
"email",
"profile"
]
string
string
Valid values[
"system"
]
string
string
Valid values[
"unregistereduser"
]
custom_metadata
object | null
property*
string additionalProperties
deactivation_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
deletion_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
des
object
cipher_mode
string
Valid values[
"ECB",
"CBC",
"CBCNOPAD",
"CFB",
"OFB",
"CTR",
"GCM",
"CCM",
"KW",
"KWP",
"FF1"
]
random_iv
boolean | null
des3
object
key_sizes
Array of integer | null
integer
Minimum0
Maximum4294967295
cipher_mode
string
Valid values[
"ECB",
"CBC",
"CBCNOPAD",
"CFB",
"OFB",
"CTR",
"GCM",
"CCM",
"KW",
"KWP",
"FF1"
]
random_iv
boolean | null
iv_length
integer (int32) | null
description
string | null
destruction_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
deterministic_signatures
boolean | null
dsa
object
subgroup_size
integer | null
Minimum0
Maximum4294967295
eckcdsa
object
hash_alg
string
Valid values[
"BLAKE2B256",
"BLAKE2B384",
"BLAKE2B512",
"BLAKE2S256",
"RIPEMD160",
"SSL3",
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512",
"STREEBOG256",
"STREEBOG512",
"SHA3_224",
"SHA3_256",
"SHA3_384",
"SHA3_512"
]
effective_key_policy
object
key_ops
Array of string (EffectiveKeyOperations)
string
Valid values[
"SIGN",
"VERIFY",
"ENCRYPT",
"DECRYPT",
"WRAPKEY",
"UNWRAPKEY",
"DERIVEKEY",
"TRANSFORM",
"MACGENERATE",
"MACVERIFY",
"EXPORT",
"APPMANAGEABLE",
"HIGHVOLUME",
"AGREEKEY",
"ENCAPSULATE",
"DECAPSULATE",
"MASKDECRYPT"
]
export_policy
OneOf
object
object
$type
string
Valid values[
"Wrapped"
]
by
OneOf
object
object
$type
string
Valid values[
"Only"
]
keys
Array of object (SobjectDescriptorPersisted)
OneOf
SobjectDescriptorPersistedVariantKid
object (SobjectDescriptorPersistedVariantKid)
kid
string (uuid)
SobjectDescriptorPersistedVariantName
object (SobjectDescriptorPersistedVariantName)
name
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
object
object
$type
string
Valid values[
"Any"
]
object
object
$type
string
Valid values[
"Unrestricted"
]
elliptic_curve
string
Valid values[
"X25519",
"Ed25519",
"X448",
"SecP192K1",
"SecP224K1",
"SecP256K1",
"NistP192",
"NistP224",
"NistP256",
"NistP384",
"NistP521",
"Gost256A"
]
enabled
boolean
export_policy
allow_weakening
boolean
OneOf
object
object
$type
string
Valid values[
"Wrapped"
]
by
OneOf
object
object
$type
string
Valid values[
"Only"
]
keys
Array of object (SobjectDescriptorPersisted)
OneOf
SobjectDescriptorPersistedVariantKid
object (SobjectDescriptorPersistedVariantKid)
kid
string (uuid)
SobjectDescriptorPersistedVariantName
object (SobjectDescriptorPersistedVariantName)
name
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
object
object
$type
string
Valid values[
"Any"
]
object
object
$type
string
Valid values[
"Unrestricted"
]
external
object
id
OneOf
object
object
id
string (byte)
label
string (byte)
object
object
id
string (uuid)
object
object
key_arn
string
key_id
string
object
object
version
string (uuid)
label
string
object
object
version
integer
Minimum0
Maximum4294967295
label
string
object
object
hsm_group_id
string (uuid)
external_kms_info
OneOf
object
object
type
string
Valid values[
"AWS"
]
multi_region
object
multi_region_key_type
string
Valid values[
"PRIMARY",
"REPLICA"
]
primary_key_arn
string | null
replica_key_arns
Array of string | null
string
aws_key_rotation_status
OneOf
object
object
type
string
Valid values[
"KeyRotationDisabled"
]
object
object
type
string
Valid values[
"KeyRotationEnabled"
]
rotation_period_in_days
integer | null
Minimum0
Maximum65535
fpe
OneOf
object
object
radix
integer
Minimum0
Maximum4294967295
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
preserve
Array of integer
integer (int64)
mask
Array of integer | null
integer (int64)
luhn_check
boolean | null
name
string | null
object
object
format
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object
multiple
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object
concat
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object
or
Array of object (FpeDataPart)
OneOf
object
object
min_length
integer
Minimum0
Maximum4294967295
max_length
integer
Minimum0
Maximum4294967295
char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
cipher_char_set
Array of array
Array of string
Min items2
Max items2
string
Min length1
Max length1
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
mask
OneOf
string
string
Valid values[
"all"
]
array
array
integer (int64)
object
object
literal
Array of string
string
object
OneOf
object
object Recursive
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
object
object Recursive
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
object
object Recursive
min_repetitions
integer | null
max_repetitions
integer | null
constraints
object
luhn_check
boolean | null
num_gt
integer | null
num_lt
integer | null
num_ne
Array of integer | null
integer
date
OneOf
object
OneOf
FpeDateVariantDayMonthYear
object (FpeDateVariantDayMonthYear)
dmy_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthDay
object (FpeDateVariantMonthDay)
month_day_date
object
before
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
after
object
month
integer
Minimum0
Maximum255
day
integer
Minimum0
Maximum255
FpeDateVariantMonthYear
object (FpeDateVariantMonthYear)
month_year_date
object
before
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
after
object
year
integer
Minimum0
Maximum4294967295
month
integer
Minimum0
Maximum255
string
string
Valid values[
"month",
"day",
"year"
]
applies_to
OneOf
string
string
Valid values[
"all"
]
object
object
property*
OneOf
string
string
Valid values[
"all"
]
object
object Recursive
preserve
boolean | null
mask
boolean | null
min_length
integer | null
Minimum0
Maximum4294967295
max_length
integer | null
Minimum0
Maximum4294967295
description
string | null
google_access_reason_policy
object
allow
Array of string (GoogleAccessReason)
string
Valid values[
"REASON_UNSPECIFIED",
"CUSTOMER_INITIATED_SUPPORT",
"GOOGLE_INITIATED_SERVICE",
"THIRD_PARTY_DATA_REQUEST",
"GOOGLE_INITIATED_REVIEW",
"CUSTOMER_INITIATED_ACCESS",
"GOOGLE_INITIATED_SYSTEM_OPERATION",
"REASON_NOT_EXPECTED",
"MODIFIED_CUSTOMER_INITIATED_ACCESS",
"MODIFIED_GOOGLE_INITIATED_SYSTEM_OPERATION",
"GOOGLE_RESPONSE_TO_PRODUCTION_ALERT",
"CUSTOMER_AUTHORIZED_WORKFLOW_SERVICING"
]
allow_missing_reason
boolean
history
Array of object | null
object
id
string (uuid)
state
object
activation_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
activation_undo_window
integer
revocation_reason
object
code
string
Valid values[
"Unspecified",
"KeyCompromise",
"CACompromise",
"AffiliationChanged",
"Superseded",
"CessationOfOperation",
"PrivilegeWithdrawn"
]
message
string | null
compromise_occurance_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
compromise_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
deactivation_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
deactivation_undo_window
integer
destruction_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
deletion_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
state
string
Valid values[
"PreActive",
"Active",
"Deactivated",
"Compromised",
"Destroyed",
"Deleted"
]
key_ops
Array of string (KeyOperations)
string
Valid values[
"SIGN",
"VERIFY",
"ENCRYPT",
"DECRYPT",
"WRAPKEY",
"UNWRAPKEY",
"DERIVEKEY",
"TRANSFORM",
"MACGENERATE",
"MACVERIFY",
"EXPORT",
"APPMANAGEABLE",
"HIGHVOLUME",
"AGREEKEY",
"ENCAPSULATE",
"DECAPSULATE"
]
public_only
boolean
has_key
boolean
rotation_policy
effective_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
deactivate_rotated_key
boolean | null
rotate_copied_keys
OneOf
string
string
Valid values[
"all_external"
]
RotateCopiedKeysVariantSelect
object (RotateCopiedKeysVariantSelect)
select
Array of string
string (uuid)
OneOf
RotationIntervalVariantIntervalDays
object (RotationIntervalVariantIntervalDays)
interval_days
integer
Minimum0
Maximum4294967295
RotationIntervalVariantIntervalMonths
object (RotationIntervalVariantIntervalMonths)
interval_months
integer
Minimum0
Maximum4294967295
group_id
string (uuid) | null
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
expiry
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
kcdsa
object
subgroup_size
integer | null
Minimum0
Maximum4294967295
hash_alg
string
Valid values[
"BLAKE2B256",
"BLAKE2B384",
"BLAKE2B512",
"BLAKE2S256",
"RIPEMD160",
"SSL3",
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512",
"STREEBOG256",
"STREEBOG512",
"SHA3_224",
"SHA3_256",
"SHA3_384",
"SHA3_512"
]
kcv
string
kcv_cmac
string
key_ops
Array of string (KeyOperations)
string
Valid values[
"SIGN",
"VERIFY",
"ENCRYPT",
"DECRYPT",
"WRAPKEY",
"UNWRAPKEY",
"DERIVEKEY",
"TRANSFORM",
"MACGENERATE",
"MACVERIFY",
"EXPORT",
"APPMANAGEABLE",
"HIGHVOLUME",
"AGREEKEY",
"ENCAPSULATE",
"DECAPSULATE"
]
key_size
integer | null
Minimum0
Maximum4294967295
kid
string (uuid) | null
links
object
replacement
string (uuid) | null
replaced
string (uuid) | null
copiedFrom
string (uuid) | null
copiedTo
Array of string | null
string (uuid)
subkeys
Array of string | null
string (uuid)
parent
string (uuid) | null
wrappingKey
string (uuid) | null
lms
object
l1_height
integer | null
Minimum0
Maximum4294967295
l2_height
integer | null
Minimum0
Maximum4294967295
digest
string
Valid values[
"BLAKE2B256",
"BLAKE2B384",
"BLAKE2B512",
"BLAKE2S256",
"RIPEMD160",
"SSL3",
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512",
"STREEBOG256",
"STREEBOG512",
"SHA3_224",
"SHA3_256",
"SHA3_384",
"SHA3_512"
]
heights
Array of integer | null
integer
node_size
integer | null
mldsa
object
param_set
string
Valid values[
"MlDsa44",
"MlDsa65",
"MlDsa87"
]
mlkem
object
param_set
string
Valid values[
"MlKem512",
"MlKem768",
"MlKem1024"
]
name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
never_exportable
boolean | null
obj_type
string
Valid values[
"AES",
"ARIA",
"DES",
"DES3",
"SEED",
"RSA",
"DSA",
"EC",
"KCDSA",
"ECKCDSA",
"BIP32",
"BLS",
"OPAQUE",
"HMAC",
"LEDABETA",
"ROUND5BETA",
"SECRET",
"LMS",
"XMSS",
"MLDSA",
"MLDSABETA",
"MLKEM",
"MLKEMBETA",
"CERTIFICATE",
"PBE"
]
origin
string
Valid values[
"FortanixHSM",
"Transient",
"External"
]
pub_key
string (byte)
public_only
boolean
publish_public_key
OneOf
object
object
state
string
Valid values[
"enabled"
]
list_previous_version
boolean
object
object
state
string
Valid values[
"disabled"
]
revocation_reason
object
code
string
Valid values[
"Unspecified",
"KeyCompromise",
"CACompromise",
"AffiliationChanged",
"Superseded",
"CessationOfOperation",
"PrivilegeWithdrawn"
]
message
string | null
compromise_occurance_date
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
rotation_policy
effective_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
deactivate_rotated_key
boolean | null
rotate_copied_keys
OneOf
string
string
Valid values[
"all_external"
]
RotateCopiedKeysVariantSelect
object (RotateCopiedKeysVariantSelect)
select
Array of string
string (uuid)
OneOf
RotationIntervalVariantIntervalDays
object (RotationIntervalVariantIntervalDays)
interval_days
integer
Minimum0
Maximum4294967295
RotationIntervalVariantIntervalMonths
object (RotationIntervalVariantIntervalMonths)
interval_months
integer
Minimum0
Maximum4294967295
rsa
object
key_size
integer | null
Minimum0
Maximum4294967295
public_exponent
integer | null
Minimum0
Maximum4294967295
encryption_policy
Array of object | null
object
padding
OneOf
RsaEncryptionPaddingPolicyVariantOaep
object (RsaEncryptionPaddingPolicyVariantOaep)
OAEP
object
mgf
OneOf
MgfPolicyVariantMgf1
object (MgfPolicyVariantMgf1)
mgf1
object
hash
string
Valid values[
"BLAKE2B256",
"BLAKE2B384",
"BLAKE2B512",
"BLAKE2S256",
"RIPEMD160",
"SSL3",
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512",
"STREEBOG256",
"STREEBOG512",
"SHA3_224",
"SHA3_256",
"SHA3_384",
"SHA3_512"
]
RsaEncryptionPaddingPolicyVariantPkcs1V15
object (RsaEncryptionPaddingPolicyVariantPkcs1V15)
PKCS1_V15
object
RsaEncryptionPaddingPolicyVariantRawDecrypt
object (RsaEncryptionPaddingPolicyVariantRawDecrypt)
RAW_DECRYPT
object
signature_policy
Array of object | null
object
padding
OneOf
RsaSignaturePaddingPolicyVariantPss
object (RsaSignaturePaddingPolicyVariantPss)
PSS
object
mgf
OneOf
MgfPolicyVariantMgf1
object (MgfPolicyVariantMgf1)
mgf1
object
hash
string
Valid values[
"BLAKE2B256",
"BLAKE2B384",
"BLAKE2B512",
"BLAKE2S256",
"RIPEMD160",
"SSL3",
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512",
"STREEBOG256",
"STREEBOG512",
"SHA3_224",
"SHA3_256",
"SHA3_384",
"SHA3_512"
]
RsaSignaturePaddingPolicyVariantPkcs1V15
object (RsaSignaturePaddingPolicyVariantPkcs1V15)
PKCS1_V15
object
minimum_key_length
integer | null
Minimum0
Maximum4294967295
scheduled_rotation
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
seed
object
cipher_mode
string
Valid values[
"ECB",
"CBC",
"CBCNOPAD",
"CFB",
"OFB",
"CTR",
"GCM",
"CCM",
"KW",
"KWP",
"FF1"
]
random_iv
boolean | null
state
string
Valid values[
"PreActive",
"Active",
"Deactivated",
"Compromised",
"Destroyed",
"Deleted"
]
transient_key
string (byte)
value
string (byte)
virtual_key_info
object
cached_key_material
boolean
wrapping_key_group_ids
Array of string | null
string (uuid)
xmss
object
height
integer | null
digest
string
Valid values[
"BLAKE2B256",
"BLAKE2B384",
"BLAKE2B512",
"BLAKE2S256",
"RIPEMD160",
"SSL3",
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512",
"STREEBOG256",
"STREEBOG512",
"SHA3_224",
"SHA3_256",
"SHA3_384",
"SHA3_512"
]
node_size
integer | null
group_id
string (uuid) | null