Jaa


Get Certificates - Get Certificates

List certificates in a specified key vault
The GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.

GET {vaultBaseUrl}/certificates?api-version=7.4
GET {vaultBaseUrl}/certificates?maxresults={maxresults}&includePending={includePending}&api-version=7.4

URI Parameters

Name In Required Type Description
vaultBaseUrl
path True

string

The vault name, for example https://myvault.vault.azure.net.

api-version
query True

string

Client API version.

includePending
query

boolean

Specifies whether to include certificates which are not completely provisioned.

maxresults
query

integer

int32

Maximum number of results to return in a page. If not specified the service will return up to 25 results.

Responses

Name Type Description
200 OK

CertificateListResult

A response message containing a list of certificates along with a link to the next page of certificates.

Other Status Codes

KeyVaultError

Key Vault error response describing why the operation failed.

Examples

GetCertificates

Sample request

GET https://myvault.vault.azure.net//certificates?api-version=7.4

Sample response

{
  "value": [
    {
      "id": "https://myvault.vault.azure.net/certificates/listCert01",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1482188987,
        "updated": 1482188987
      }
    },
    {
      "id": "https://myvault.vault.azure.net/certificates/listCert02",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1482188988,
        "updated": 1482188988
      }
    }
  ],
  "nextLink": null
}

Definitions

Name Description
CertificateAttributes

The certificate management attributes.

CertificateItem

The certificate item containing certificate metadata.

CertificateListResult

The certificate list result.

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval.

Error

The key vault server error.

KeyVaultError

The key vault error exception.

CertificateAttributes

The certificate management attributes.

Name Type Description
created

integer

Creation time in UTC.

enabled

boolean

Determines whether the object is enabled.

exp

integer

Expiry date in UTC.

nbf

integer

Not before date in UTC.

recoverableDays

integer

softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.

recoveryLevel

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval.

updated

integer

Last updated time in UTC.

CertificateItem

The certificate item containing certificate metadata.

Name Type Description
attributes

CertificateAttributes

The certificate management attributes.

id

string

Certificate identifier.

tags

object

Application specific metadata in the form of key-value pairs.

x5t

string

Thumbprint of the certificate.

CertificateListResult

The certificate list result.

Name Type Description
nextLink

string

The URL to get the next set of certificates.

value

CertificateItem[]

A response message containing a list of certificates in the key vault along with a link to the next page of certificates.

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for certificates in the current vault. If it contains 'Purgeable', the certificate can be permanently deleted by a privileged user; otherwise, only the system can purge the certificate, at the end of the retention interval.

Name Type Description
CustomizedRecoverable

string

Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.

CustomizedRecoverable+ProtectedSubscription

string

Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.

CustomizedRecoverable+Purgeable

string

Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.

Purgeable

string

Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)

Recoverable

string

Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered

Recoverable+ProtectedSubscription

string

Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered

Recoverable+Purgeable

string

Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered

Error

The key vault server error.

Name Type Description
code

string

The error code.

innererror

Error

The key vault server error.

message

string

The error message.

KeyVaultError

The key vault error exception.

Name Type Description
error

Error

The key vault server error.