Set Certificate Contacts - Set Certificate Contacts

Sets the certificate contacts for the specified key vault.
Sets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.

PUT {vaultBaseUrl}/certificates/contacts?api-version=7.0

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.

Request Body

Name Type Description
contacts

The contact list for the vault certificates.

Responses

Name Type Description
200 OK

The contacts for the key vault certificate.

Other Status Codes

Key Vault error response describing why the operation failed.

Examples

SetCertificateContacts

Sample Request

PUT {vaultBaseUrl}/certificates/contacts?api-version=7.0
{
  "contacts": [
    {
      "email": "admin@contoso.com",
      "name": "John Doe",
      "phone": "1111111111"
    },
    {
      "email": "admin@contoso2.com",
      "name": "Johnathan Doeman",
      "phone": "2222222222"
    }
  ]
}

Sample Response

{
  "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/contacts",
  "contacts": [
    {
      "email": "admin@contoso.com",
      "name": "John Doe",
      "phone": "1111111111"
    },
    {
      "email": "admin@contoso2.com",
      "name": "Johnathan Doeman",
      "phone": "2222222222"
    }
  ]
}

Definitions

Contact

The contact information for the vault certificates.

Contacts

The contacts for the vault certificates.

Error

The key vault server error.

KeyVaultError

The key vault error exception.

Contact

The contact information for the vault certificates.

Name Type Description
email
  • string

Email address.

name
  • string

Name.

phone
  • string

Phone number.

Contacts

The contacts for the vault certificates.

Name Type Description
contacts

The contact list for the vault certificates.

id
  • string

Identifier for the contacts collection.

Error

The key vault server error.

Name Type Description
code
  • string

The error code.

innererror

The key vault server error.

message
  • string

The error message.

KeyVaultError

The key vault error exception.

Name Type Description
error

The key vault server error.