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.4
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
issuer-name
|
path | True |
string |
The name of the issuer. The value you provide may be copied globally for the purpose of running the service. The value provided should not include personally identifiable or sensitive information. |
vault
|
path | True |
string |
The vault name, for example https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Client API version. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
provider | True |
string |
The issuer provider. |
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. |
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 https://myvault.vault.azure.net//certificates/issuers/issuer01?api-version=7.4
{
"provider": "Test",
"credentials": {
"account_id": "keyvaultuser",
"pwd": "password"
},
"org_details": {
"admin_details": [
{
"first_name": "John",
"last_name": "Doe",
"email": "admin@microsoft.com",
"phone": "4255555555"
}
]
}
}
Sample Response
{
"id": "https://myvault.vault.azure.net/certificates/issuers/issuer01",
"provider": "Test",
"credentials": {
"account_id": "keyvaultuser"
},
"org_details": {
"admin_details": [
{
"first_name": "John",
"last_name": "Doe",
"email": "admin@microsoft.com",
"phone": "4255555555"
}
]
},
"attributes": {
"enabled": true,
"created": 1482188806,
"updated": 1482189526
}
}
Definitions
Name | Description |
---|---|
Administrator |
Details of the organization administrator of the certificate issuer. |
Certificate |
The certificate issuer set parameters. |
Error |
The key vault server error. |
Issuer |
The attributes of an issuer managed by the Key Vault service. |
Issuer |
The issuer for Key Vault certificate. |
Issuer |
The credentials to be used for the certificate issuer. |
Key |
The key vault error exception. |
Organization |
Details of the organization of the certificate issuer. |
AdministratorDetails
Details of the organization administrator of the certificate issuer.
Name | Type | Description |
---|---|---|
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. |