Create profile

  3 minute read  

POST https://caas.digicert.com/automationws/v1/profile/createProfile
Use this endpoint to create an automation profile for certificate deployment.

This endpoint supports:

  • Configuring an automation profile for an ACME automation agent (agent-based automation).
  • Configuring a sensor profile to automate certificate requests on load balancers (agentless automation).

For more information, see Automation profiles.

cURL

curl --location --request POST 'https://caas.digicert.com/automationws/v1/profile/createProfile' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "testprofile",
    "productType": "SSL_EV_SECURESITE",
    "validityPeriod": "1Y",
    "signatureHash": "sha256",
    "ctLogOption": false,
    "organizationId": 635082,
    "organizationName": "Win the Customer, LLC",
    "keySizeAndAlgorithm": "RSA 2048",
    "emailAddresses": "cc.admin@cert-testing.com",
    "divisionId": 69748,
    "isDefault": false,
    "profileType": "SENSOR",
    "accountId": "126993",
    "productName": "Secure Site EV SSL",
    "contacts": [
        {
            "contactId": 512773,
            "contactType": "org_contact"
        }
    ],
    "autoRenewSettings": {
        "daysBeforeExpiry": 30,
        "isAutoReplace": false
    }
}'

200 OK

{
    "error": null,
    "data": {
        "message": "Automation Profile Created Successfully",
        "id": 339
    }
}

Request parameters

NameReq/OptTypeDescription
namerequiredstringName of the automation profile.
productTyperequiredstringType of the product.
Allowed values: See Glossary – Product identifiers.
validityPeriodrequiredstringCertificate validity.
Allowed values: 1D, 1Y Ends with D – Day or Y - Year.
Example:
1Y
Max value:
397 days
signatureHashoptionalstringHash type ID for the algorithm used to sign the certificate.
Allowed values: See Glossary – Hash types.
ctLogOptionoptionalbooleanUse this option to enable CT logging for issued SSL certificates.
organizationIdoptionalintegerThe ID of an existing organization to associate with the profile. To get the ID of organizations in your account, use the endpoint List organizations.
organizationNamerequiredstringThe name of the organization.
keySizeAndAlgorithmoptionalstringThe key size and algorithm used to sign the certificate.
Allowed values: RSA 2048, RSA 4096, RSA 8192, ECC P256, ECC P384
emailAddressesoptionalstringEmail address for the contact associated with the automation profile.
divisionIdrequiredintegerDivision ID.
isDefaultoptionalbooleanIf true, sets the profile to be the default.
profileTypeoptionalstringType of profile.
Allowed values: ACME or SENSOR
accountIdrequiredstringAccount ID.
productNameoptionalstringName of the product.
Allowed values: See Glossary – Product identifiers.
contactsoptionalarrayObject container for automation profile contacts.
.. contactIdoptionalintegerID of existing user or contact for the account. This can be omitted if you are adding a new contact. To get the IDs for users in your account, use the endpoint User info.
.. contactTypeoptionalstringType of contact to add to the profile.
Allowed values: org_contact, technical_contact, ev_approver
.. contactNameoptionalstringName of the contact.
autoRenewSettingsoptionalobjectObject with auto-renew settings.
.. daysBeforeExpiryoptionalintegerNumber of days before expiration to renew the certificate.
Min: 1 day
Max: Less than the certificate validity.
.. isAutoReplaceoptionalbooleanFor a revoked or missing certificate, true requests and installs the certificate.
Default: false
canSignHttpExchangesExtensionoptionalbooleanThis parameter is used to issue certificates with “canSignHttpExchanges” extension. Note that this certificate profile option must be enabled for your account in order to use it for other certificates. For more information, See Get your Signed HTTP Exchanges certificate.
customFieldsoptional*arrayAccount-specific custom fields.
*Whether or not these fields are required depends on your custom field settings.
.. idoptionalintegerCustom field ID.
.. valueoptionalobjectValue of the custom field.
caCertIdoptional*stringID of the CA certificate that should sign the certificate.
*Required if multiple CA certificates are configured.
Note: If not specified, the default CA certificate is used.
caCertNameoptionalstringName of the CA certificate that should sign the certificate.

Response parameters

NameTypeDescription
errorobjectObject with error details.
dataobjectObject with response data.
.. messagestringMessage with details about successful creation.
.. idintegerIdentification number for the profile.