Get
/sys/v1/apps
Get details of all apps accessible to requester.
Security
HTTP
Type bearer
API Key
Header parameter nameAuthorization
Query parameters
ListAppsParams
group_id
string (uuid)
limit
integer
offset
integer
group_permissions
boolean
role
string
Valid values[
"admin",
"crypto"
]
filter
string
continuation_token
string
OneOf
AppSortVariantByAppId
object (AppSortVariantByAppId)
sort
string Required
Pattern^app_id:(?:asc|desc)$
start
string (uuid)
AppSortVariantByAppName
object (AppSortVariantByAppName)
sort
string Required
Pattern^app_name:(?:asc|desc)$
start
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
Responses
2XX
Success result
The response of the get all apps API
OneOf
object
object
items
Array of object (App)
object
account_membership
object
roles
Array of object (AppAccountRoleDescriptor)
OneOf
object
object
$type
string
Valid values[
"SystemDefined"
]
value
string
Valid values[
"AccountAdministrator",
"AccountMember",
"AccountAuditor"
]
object
object
$type
string
Valid values[
"Custom"
]
value
string (uuid)
acct_id
string (uuid)
app_id
string (uuid)
app_type
string
auth_type
string
Valid values[
"Secret",
"Certificate",
"TrustedCa",
"GoogleServiceAccount",
"SignedJwt",
"Ldap",
"AwsIam",
"AwsXks",
"GoogleWorkspaceCSE"
]
cert_not_after
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
client_configurations
object
common
object
retry_timeout_millis
integer | null
cache_ttl
integer | null
log
object
system
boolean | null
file
OneOf
object
object
mode
string
Valid values[
"enabled"
]
path
string | null
file_size_kb
integer | null
max_files
integer | null
Minimum0
Maximum4294967295
object
object
mode
string
Valid values[
"disabled"
]
level
string | null
h2_num_connections
integer | null
quorum_approval
object
wait_for_quorum_approval
object
enabled
boolean
poll_interval_secs
integer | null
max_wait_for_secs
integer | null
pkcs11
object
fake_rsa_x9_31_keygen_support
boolean | null
signing_aes_key_as_hmac
boolean | null
exact_key_ops
boolean | null
prevent_duplicate_opaque_objects
boolean | null
opaque_objects_are_not_certificates
boolean | null
max_concurrent_requests_per_slot
integer | null
kmip
object
ignore_unknown_key_ops_for_secrets
boolean | null
ignore_unknown_key_ops_for
OneOf
object
object
$type
string
Valid values[
"All"
]
object
object
$type
string
Valid values[
"Selection"
]
selection
Array of string (ObjectType)
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"
]
key_ops_override
object
add_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"
]
tep
object
schema
OneOf
object
object
$type
string
Valid values[
"OpenAPI"
]
openapi
string
key_map
Array of object
object
path
object
api_path
string
method
string
context
string
Valid values[
"request",
"response"
]
key_path
string
kid
string (uuid)
mode
string
Valid values[
"ECB",
"CBC",
"CBCNOPAD",
"CFB",
"OFB",
"CTR",
"GCM",
"CCM",
"KW",
"KWP",
"FF1"
]
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"
]
default_group
string (uuid) | null
description
string | null
enabled
boolean
groups
OneOf
object
object
property*
Array of string (AppPermissions) additionalProperties
string
Valid values[
"SIGN",
"VERIFY",
"ENCRYPT",
"DECRYPT",
"WRAPKEY",
"UNWRAPKEY",
"DERIVEKEY",
"MACGENERATE",
"MACVERIFY",
"EXPORT",
"MANAGE",
"AGREEKEY",
"MASKDECRYPT",
"AUDIT",
"TRANSFORM",
"CREATE_SOBJECTS",
"COPY_SOBJECTS",
"ROTATE_SOBJECTS",
"ACTIVATE_SOBJECTS",
"REVOKE_SOBJECTS",
"REVERT_SOBJECTS",
"MOVE_SOBJECTS",
"UPDATE_SOBJECTS_PROFILE",
"UPDATE_SOBJECTS_ENABLED_STATE",
"UPDATE_SOBJECT_POLICIES",
"UPDATE_KEY_OPS",
"DELETE_KEY_MATERIAL",
"DELETE_SOBJECTS",
"DESTROY_SOBJECTS",
"RESTORE_EXTERNAL_SOBJECTS",
"CALCULATE_DIGEST",
"ENCAPSULATE",
"DECAPSULATE"
]
array
array
string (uuid)
interface
string | null
ip_address_policy
OneOf
string
string
Valid values[
"allow_all"
]
IpAddressPolicyVariantWhitelist
object (IpAddressPolicyVariantWhitelist)
whitelist
Array of string
string
last_operations
object
generic
integer | null
tokenization
integer | null
tep
integer | null
accelerator
integer | null
secrets_management
integer | null
lastused_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
legacy_access
boolean
name
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
oauth_config
OneOf
object
object
state
string
Valid values[
"enabled"
]
redirect_uris
Array of string
string
object
object
state
string
Valid values[
"disabled"
]
role
string
Valid values[
"admin",
"crypto"
]
metadata
object
continuation_token
string | null
count
integer
count_accuracy
OneOf
object
object
$type
string
Valid values[
"Exact"
]
object
object
$type
string
Valid values[
"Approximate"
]
App
array (App)
object
account_membership
object
roles
Array of object (AppAccountRoleDescriptor)
OneOf
object
object
$type
string
Valid values[
"SystemDefined"
]
value
string
Valid values[
"AccountAdministrator",
"AccountMember",
"AccountAuditor"
]
object
object
$type
string
Valid values[
"Custom"
]
value
string (uuid)
acct_id
string (uuid)
app_id
string (uuid)
app_type
string
auth_type
string
Valid values[
"Secret",
"Certificate",
"TrustedCa",
"GoogleServiceAccount",
"SignedJwt",
"Ldap",
"AwsIam",
"AwsXks",
"GoogleWorkspaceCSE"
]
cert_not_after
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
client_configurations
object
common
object
retry_timeout_millis
integer | null
cache_ttl
integer | null
log
object
system
boolean | null
file
OneOf
object
object
mode
string
Valid values[
"enabled"
]
path
string | null
file_size_kb
integer | null
max_files
integer | null
Minimum0
Maximum4294967295
object
object
mode
string
Valid values[
"disabled"
]
level
string | null
h2_num_connections
integer | null
quorum_approval
object
wait_for_quorum_approval
object
enabled
boolean
poll_interval_secs
integer | null
max_wait_for_secs
integer | null
pkcs11
object
fake_rsa_x9_31_keygen_support
boolean | null
signing_aes_key_as_hmac
boolean | null
exact_key_ops
boolean | null
prevent_duplicate_opaque_objects
boolean | null
opaque_objects_are_not_certificates
boolean | null
max_concurrent_requests_per_slot
integer | null
kmip
object
ignore_unknown_key_ops_for_secrets
boolean | null
ignore_unknown_key_ops_for
OneOf
object
object
$type
string
Valid values[
"All"
]
object
object
$type
string
Valid values[
"Selection"
]
selection
Array of string (ObjectType)
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"
]
key_ops_override
object
add_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"
]
tep
object
schema
OneOf
object
object
$type
string
Valid values[
"OpenAPI"
]
openapi
string
key_map
Array of object
object
path
object
api_path
string
method
string
context
string
Valid values[
"request",
"response"
]
key_path
string
kid
string (uuid)
mode
string
Valid values[
"ECB",
"CBC",
"CBCNOPAD",
"CFB",
"OFB",
"CTR",
"GCM",
"CCM",
"KW",
"KWP",
"FF1"
]
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"
]
default_group
string (uuid) | null
description
string | null
enabled
boolean
groups
OneOf
object
object
property*
Array of string (AppPermissions) additionalProperties
string
Valid values[
"SIGN",
"VERIFY",
"ENCRYPT",
"DECRYPT",
"WRAPKEY",
"UNWRAPKEY",
"DERIVEKEY",
"MACGENERATE",
"MACVERIFY",
"EXPORT",
"MANAGE",
"AGREEKEY",
"MASKDECRYPT",
"AUDIT",
"TRANSFORM",
"CREATE_SOBJECTS",
"COPY_SOBJECTS",
"ROTATE_SOBJECTS",
"ACTIVATE_SOBJECTS",
"REVOKE_SOBJECTS",
"REVERT_SOBJECTS",
"MOVE_SOBJECTS",
"UPDATE_SOBJECTS_PROFILE",
"UPDATE_SOBJECTS_ENABLED_STATE",
"UPDATE_SOBJECT_POLICIES",
"UPDATE_KEY_OPS",
"DELETE_KEY_MATERIAL",
"DELETE_SOBJECTS",
"DESTROY_SOBJECTS",
"RESTORE_EXTERNAL_SOBJECTS",
"CALCULATE_DIGEST",
"ENCAPSULATE",
"DECAPSULATE"
]
array
array
string (uuid)
interface
string | null
ip_address_policy
OneOf
string
string
Valid values[
"allow_all"
]
IpAddressPolicyVariantWhitelist
object (IpAddressPolicyVariantWhitelist)
whitelist
Array of string
string
last_operations
object
generic
integer | null
tokenization
integer | null
tep
integer | null
accelerator
integer | null
secrets_management
integer | null
lastused_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
legacy_access
boolean
name
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
oauth_config
OneOf
object
object
state
string
Valid values[
"enabled"
]
redirect_uris
Array of string
string
object
object
state
string
Valid values[
"disabled"
]
role
string
Valid values[
"admin",
"crypto"
]