Update Certificate Issuer - Update Certificate Issuer

Reference

Service:: Key Vault

API Version:: 7.4

Updates the specified certificate issuer.
The UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers permission.

PATCH {vaultBaseUrl}/certificates/issuers/{issuer-name}?api-version=7.4

URI Parameters

Name	In	Required	Type	Description
issuer-name	path	True	string	The name of the issuer.
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
attributes	IssuerAttributes	Attributes of the issuer object.
credentials	IssuerCredentials	The credentials to be used for the issuer.
org_details	OrganizationDetails	Details of the organization as provided to the issuer.
provider	string	The issuer provider.

Responses

Name	Type	Description
200 OK	IssuerBundle	The issuer for the key vault certificate.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

UpdateCertificateIssuer

Sample request

HTTP

PATCH https://myvault.vault.azure.net//certificates/issuers/issuer01?api-version=7.4

{
  "provider": "Test",
  "credentials": {
    "account_id": "newuseraccount",
    "pwd": "newpassword"
  }
}

Sample response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/issuers/issuer01",
  "provider": "Test",
  "credentials": {
    "account_id": "newuseraccount"
  },
  "org_details": {
    "admin_details": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone": "4255555555"
      }
    ]
  },
  "attributes": {
    "enabled": true,
    "created": 1482188806,
    "updated": 1482189526
  }
}

Definitions

Name	Description
AdministratorDetails	Details of the organization administrator of the certificate issuer.
CertificateIssuerUpdateParameters	The certificate issuer update parameters.
Error	The key vault server error.
IssuerAttributes	The attributes of an issuer managed by the Key Vault service.
IssuerBundle	The issuer for Key Vault certificate.
IssuerCredentials	The credentials to be used for the certificate issuer.
KeyVaultError	The key vault error exception.
OrganizationDetails	Details of the organization of the certificate issuer.

AdministratorDetails

Details of the organization administrator of the certificate issuer.

Name	Type	Description
email	string	Email address.
first_name	string	First name.
last_name	string	Last name.
phone	string	Phone number.

CertificateIssuerUpdateParameters

The certificate issuer update parameters.

Name	Type	Description
attributes	IssuerAttributes	Attributes of the issuer object.
credentials	IssuerCredentials	The credentials to be used for the issuer.
org_details	OrganizationDetails	Details of the organization as provided to the issuer.
provider	string	The issuer provider.

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.

IssuerAttributes

The attributes of an issuer managed by the Key Vault service.

Name	Type	Description
created	integer	Creation time in UTC.
enabled	boolean	Determines whether the issuer is enabled.
updated	integer	Last updated time in UTC.

IssuerBundle

The issuer for Key Vault certificate.

Name	Type	Description
attributes	IssuerAttributes	Attributes of the issuer object.
credentials	IssuerCredentials	The credentials to be used for the issuer.
id	string	Identifier for the issuer object.
org_details	OrganizationDetails	Details of the organization as provided to the issuer.
provider	string	The issuer provider.

IssuerCredentials

The credentials to be used for the certificate issuer.

Name	Type	Description
account_id	string	The user name/account name/account id.
pwd	string	The password/secret/account key.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

OrganizationDetails

Details of the organization of the certificate issuer.

Name	Type	Description
admin_details	AdministratorDetails[]	Details of the organization administrator.
id	string	Id of the organization.

Share via