Updating SSL/TLS provider credentials¶

Note

This request is only available to members of the root group and organisation administrators. The ID of the entry in the path of the request must match the value of the attribute id in the body. Deleted or non-existent credentials always return a 403 response instead of a 404 response.

Sends a PUT request to the endpoint /ssl/providers/{id}.

Description¶

The Update-Ssl-Provider-Credentials request updates existing SSL/TLS provider credentials of the organisation.

Requirements¶

Values of the request: Provider-ID {id}

Objects: SslProviderCredentialsVO

Request¶

To update SSL/TLS provider credentials, add the Provider-ID {id} to the path of the request. For a detailed specification of which information is required to update SSL/TLS provider credentials, an object SslProviderCredentialsVO with the following attributes must be defined in the body:

Attributes	Description	Values
`id`	The ID of the credentials entry. Must match the Provider-ID `{id}` in the path.	`integer`
`name`	The name of the credentials entry.	`string`
`provider`	The ACME provider to which these credentials belong.	`SECTIGO` `DTRUST`
`eabKid`	The EAB KID (External Account Binding Key Identifier) of the ACME account.	`string`

The following attributes are optional:

Attributes	Description	Values
`eabHmac`	The EAB HMAC key of the ACME account. Any authorised user can rotate it. If the field remains empty, the saved value is retained.	`string`
`cert`	The certificate of the ACME account. If the field remains empty, the saved value is retained.	`string`
`privateKey`	The private key belonging to `cert`. Can only be changed by Myra super administrators; for other callers, the value is ignored. If the field remains empty, the saved value is retained.	`string`
`email`	The contact email address of the ACME account. Must remain empty for the provider `DTRUST`. For `SECTIGO`, an empty value deletes the saved contact email address.	`string`
`endpoint`	The ACME endpoint URL. Required for the provider `SECTIGO`, must be a valid URL if set.	`string`
`comment`	An individual comment for the entry.	`string`

The system returns the object SslProviderCredentialsVO with the updated information.

Example¶

Example request body:

{
  "name": "My Sectigo Account",
  "provider": "SECTIGO",
  "eabKid": "kid-12345",
  "eabHmac": "base64-hmac-value",
  "cert": "-----BEGIN CERTIFICATE-----...",
  "privateKey": "-----BEGIN PRIVATE KEY-----...",
  "email": "admin@example.com",
  "endpoint": "https://acme.sectigo.com/v2/OV",
  "comment": "Sectigo production account"
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.