Get an application's credential.

  • Published on Apr 2, 2025
  • 1 minute(s) read
Get
/sys/v1/apps/{app_id}/credential

In FIPS mode this secret will be reset after 100 failed API key authentication attempts in a 24 hour period.

Security
HTTP
Type bearer
API Key
Header parameter nameAuthorization
Path parameters
app_id
string (uuid) Required
Responses
2XX

Success result

Expand All
object
app_id
string (uuid)
credential
OneOf
AppCredentialVariantSecret
object (AppCredentialVariantSecret)
secret
string
AppCredentialVariantCertificate
object (AppCredentialVariantCertificate)
certificate
string (byte)
AppCredentialVariantTrustedCa
object (AppCredentialVariantTrustedCa)
trustedca
ca_certificate
string (byte)
check_revocation
boolean | null
OneOf
TrustAnchorSubjectVariantSubject
object (TrustAnchorSubjectVariantSubject)
subject
Array of array
Array of string
Min items2
Max items2
string
TrustAnchorSubjectVariantSubjectGeneral
object (TrustAnchorSubjectVariantSubjectGeneral)
subject_general
OneOf
SubjectGeneralVariantDirectoryName
object (SubjectGeneralVariantDirectoryName)
directory_name
Array of array
Array of string
Min items2
Max items2
string
SubjectGeneralVariantDnsName
object (SubjectGeneralVariantDnsName)
dns_name
string
SubjectGeneralVariantIpAddress
object (SubjectGeneralVariantIpAddress)
ip_address
OneOf
string (ipv4)
string
string (ipv6)
string
AppCredentialVariantGoogleServiceAccount
object (AppCredentialVariantGoogleServiceAccount)
googleserviceaccount
object
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
groups
object | null
property*
Array of string (GcpAppPermissions) additionalProperties
string
Valid values[ "CRYPTO_SPACE_GET_INFO", "CRYPTO_SPACE_GET_PUBLIC_KEY" ]
AppCredentialVariantSignedJwt
object (AppCredentialVariantSignedJwt)
signedjwt
object
valid_issuers
Array of string
string
signing_keys
OneOf
object
object
kind
string
Valid values[ "stored" ]
keys
object
property*
string (byte) additionalProperties
object
object
kind
string
Valid values[ "fetched" ]
url
string
cache_duration
integer
AppCredentialVariantLdap
object (AppCredentialVariantLdap)
ldap
string (uuid)
AppCredentialVariantAwsIam
object (AppCredentialVariantAwsIam)
awsiam
object
AppCredentialVariantAwsXks
object (AppCredentialVariantAwsXks)
awsxks
object
access_key_id
string | null
secret_key
string
AppCredentialVariantGoogleWorkspaceCse
object (AppCredentialVariantGoogleWorkspaceCse)
googleworkspacecse
object
previous_credential
object
credential
OneOf
AppCredentialVariantSecret
object (AppCredentialVariantSecret)
secret
string
AppCredentialVariantCertificate
object (AppCredentialVariantCertificate)
certificate
string (byte)
AppCredentialVariantTrustedCa
object (AppCredentialVariantTrustedCa)
trustedca
ca_certificate
string (byte)
check_revocation
boolean | null
OneOf
TrustAnchorSubjectVariantSubject
object (TrustAnchorSubjectVariantSubject)
subject
Array of array
Array of string
Min items2
Max items2
string
TrustAnchorSubjectVariantSubjectGeneral
object (TrustAnchorSubjectVariantSubjectGeneral)
subject_general
OneOf
SubjectGeneralVariantDirectoryName
object (SubjectGeneralVariantDirectoryName)
directory_name
Array of array
Array of string
Min items2
Max items2
string
SubjectGeneralVariantDnsName
object (SubjectGeneralVariantDnsName)
dns_name
string
SubjectGeneralVariantIpAddress
object (SubjectGeneralVariantIpAddress)
ip_address
OneOf
string (ipv4)
string
string (ipv6)
string
AppCredentialVariantGoogleServiceAccount
object (AppCredentialVariantGoogleServiceAccount)
googleserviceaccount
object
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
groups
object | null
property*
Array of string (GcpAppPermissions) additionalProperties
string
Valid values[ "CRYPTO_SPACE_GET_INFO", "CRYPTO_SPACE_GET_PUBLIC_KEY" ]
AppCredentialVariantSignedJwt
object (AppCredentialVariantSignedJwt)
signedjwt
object
valid_issuers
Array of string
string
signing_keys
OneOf
object
object
kind
string
Valid values[ "stored" ]
keys
object
property*
string (byte) additionalProperties
object
object
kind
string
Valid values[ "fetched" ]
url
string
cache_duration
integer
AppCredentialVariantLdap
object (AppCredentialVariantLdap)
ldap
string (uuid)
AppCredentialVariantAwsIam
object (AppCredentialVariantAwsIam)
awsiam
object
AppCredentialVariantAwsXks
object (AppCredentialVariantAwsXks)
awsxks
object
access_key_id
string | null
secret_key
string
AppCredentialVariantGoogleWorkspaceCse
object (AppCredentialVariantGoogleWorkspaceCse)
googleworkspacecse
object
valid_until
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$