Set Certificate Issuer - Set Certificate Issuer

Sets the specified certificate issuer.
The SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.

PUT {vaultBaseUrl}/certificates/issuers/{issuer-name}?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.

issuer-name
path True
  • string

The name of the issuer.

api-version
query True
  • string

Client API version.

Request Body

Name Required Type Description
attributes

Attributes of the issuer object.

credentials

The credentials to be used for the issuer.

org_details

Details of the organization as provided to the issuer.

provider True
  • string

The issuer provider.

Responses

Name Type Description
200 OK

The issuer for the key vault certificate.

Other Status Codes

Key Vault error response describing why the operation failed.

Examples

SetCertificateIssuer

Sample Request

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

Sample Response

{
  "id": "https://karlaugsoftdeletesdk.vault-int.azure-int.net/certificates/issuers/issuer01",
  "provider": "Test",
  "credentials": {
    "account_id": "keyvaultuser"
  },
  "org_details": {
    "zip": 0,
    "admin_details": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "email": "admin@microsoft.com",
        "phone": "4255555555"
      }
    ]
  },
  "attributes": {
    "enabled": true,
    "created": 1482188806,
    "updated": 1482189526
  }
}

Definitions

AdministratorDetails

Details of the organization administrator of the certificate issuer.

CertificateIssuerSetParameters

The certificate issuer set 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.

CertificateIssuerSetParameters

The certificate issuer set parameters.

Name Type Description
attributes

Attributes of the issuer object.

credentials

The credentials to be used for the issuer.

org_details

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

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

Attributes of the issuer object.

credentials

The credentials to be used for the issuer.

id
  • string

Identifier for the issuer object.

org_details

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

The key vault server error.

OrganizationDetails

Details of the organization of the certificate issuer.

Name Type Description
admin_details

Details of the organization administrator.

id
  • string

Id of the organization.