Creating SSL/TLS provider credentials¶

Note

This request is only available to members of the root group and organisation administrators. The attribute id must not be contained in the body.

Sends a POST request to the endpoint /ssl/providers.

Description¶

The Create-Ssl-Provider-Credentials request creates new SSL/TLS provider credentials for the organisation.

Requirements¶

Values of the request: none Objects: SslProviderCredentialsVO

Request¶

To create SSL/TLS provider credentials, send a POST request to the endpoint /ssl/providers. For a detailed specification of which information is required to create SSL/TLS provider credentials, an object SslProviderCredentialsVO with the following attributes must be defined in the body:

Attributes	Description	Values
`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`
`eabHmac`	The EAB HMAC key of the ACME account.	`string`

The following attributes are optional:

Attributes	Description	Values
`cert`	The certificate of the ACME account. If `cert` and `privateKey` both remain empty, Myra automatically generates a self-signed placeholder key pair; specifying only one of the two attributes is rejected.	`string`
`privateKey`	The private key belonging to `cert`. The same automatic generation rule applies as for `cert`.	`string`
`email`	The contact email address of the ACME account. Must remain empty for the provider `DTRUST`.	`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 created 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
201	The request has succeeded and a new object has been created.
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.