Credential vault API - GET credentials metadata

  • Reference
  • Published Oct 06, 2022

Gets the metadata of the specified set of credentials for synthetic monitors. The credentials set itself (username/certificate and password) is not included in the response.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/credentials/{id}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/credentials/{id}

Authentication

To execute this request, you need an access token with credentialVault.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The Dynatrace entity ID of the required credentials set.

pathrequired

Response

Response codes

CodeTypeDescription
200CredentialsResponseElement

Success. The response contains the metadata of the credentials set.

400ErrorEnvelope

Failed. The input is invalid.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The CredentialsResponseElement object

Metadata of the credentials set.

ElementTypeDescription
allowContextlessRequestsboolean

Allow access without app context, for example, from ad hoc functions in Workflows (requires the APP_ENGINE scope).

allowedEntitiesCredentialAccessData[]

The set of entities allowed to use the credential.

credentialUsageSummaryCredentialUsageHandler[]

The list contains summary data related to the use of credentials.

descriptionstring

A short description of the credentials set.

externalVaultExternalVaultConfig

Configuration for external vault synchronization for username and password credentials.

idstring

The ID of the credentials set.

namestring

The name of the credentials set.

ownerstring

The owner of the credential (user for which used API token was created).

ownerAccessOnlyboolean

Flag indicating that this credential is visible only to the owner.

scopestring

The scope of the credentials set.

  • APP_ENGINE
  • EXTENSION
  • SYNTHETIC
scopesstring[]

The set of scopes of the credentials set.

  • APP_ENGINE
  • EXTENSION
  • SYNTHETIC
typestring

The type of the credentials set.

  • AWS_MONITORING_KEY_BASED
  • AWS_MONITORING_ROLE_BASED
  • CERTIFICATE
  • PUBLIC_CERTIFICATE
  • SNMPV3
  • TOKEN
  • UNKNOWN
  • USERNAME_PASSWORD

The CredentialAccessData object

The set of entities allowed to use the credential.

ElementTypeDescription
idstring-
typestring-
  • APPLICATION
  • UNKNOWN
  • USER

The CredentialUsageHandler object

Keeps information about credential's usage.

ElementTypeDescription
countinteger

The number of uses.

typestring

Type of usage.

The ExternalVaultConfig object

Configuration for external vault synchronization for username and password credentials.

ElementTypeDescription
credentialsUsedForExternalSynchronizationstring[]-
passwordSecretNamestring-
sourceAuthMethodstring

Defines the actual set of fields depending on the value. See one of the following objects:

  • HASHICORP_VAULT_APPROLE -> HashicorpApproleConfig
  • HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificateConfig
  • AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecretConfig
  • CYBERARK_VAULT_USERNAME_PASSWORD -> CyberArkUsernamePasswordConfig
  • CYBERARK_VAULT_ALLOWED_LOCATION -> CyberArkAllowedLocationConfig
  • AZURE_KEY_VAULT_CLIENT_SECRET
  • CYBERARK_VAULT_ALLOWED_LOCATION
  • CYBERARK_VAULT_USERNAME_PASSWORD
  • HASHICORP_VAULT_APPROLE
  • HASHICORP_VAULT_CERTIFICATE
tokenSecretNamestring-
typestring-
  • AZURE_CERTIFICATE_MODEL
  • AZURE_CLIENT_SECRET_MODEL
  • CYBERARK_VAULT_ALLOWED_LOCATION_MODEL
  • CYBERARK_VAULT_USERNAME_PASSWORD_MODEL
  • HASHICORP_APPROLE_MODEL
  • HASHICORP_CERTIFICATE_MODEL
usernameSecretNamestring-
vaultUrlstring-

Response body JSON model

{
  "allowContextlessRequests": "false",
  "credentialUsageSummary": [
    {
      "BROWSER_MONITOR": 2,
      "HTTP_MONITOR": 3
    }
  ],
  "description": "Sample credentials for demo purposes.",
  "externalVault": {
    "passwordSecretName": "password",
    "pathToCredentials": "kv/credentials",
    "roleId": "00e4858c-ec33-bc99-4e7e-34de6967de6c",
    "secretId": "CREDENTIALS_VAULT-XXXXXXXXXXXXXXXX",
    "sourceAuthMethod": "HASHICORP_VAULT_APPROLE",
    "usernameSecretName": "username",
    "vaultNamespace": "admin",
    "vaultUrl": "https://vault-cluster.vault.fb17d2fc-be92-4230-afa2-91dbfda3cbad.aws.hashicorp.cloud:8200"
  },
  "id": "CREDENTIALS_VAULT-C43F2C2E6395AD23",
  "name": "Sample username-password credentials",
  "owner": "user@domain.com",
  "ownerAccessOnly": true,
  "scope": "SYNTHETIC",
  "type": "USERNAME_PASSWORD"
}