Update profile details

3 minute read

POST https://caas.digicert.com/automationws/v1/profile/updateProfile

Use this endpoint to update an automation profile.

For more information, see Automation profiles.

Example requests and responses

cURL

curl --location --request POST 'https://caas.digicert.com/automationws/v1/profile/updateProfile' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": "5153184",
    "id": 813,
    "userId": 7286246,
    "name": "testprofile",
    "profileState": "ACTIVE",
    "isDefault": false,
    "ctLogOption": false,
    "productType": "SSL_EV_SECURESITE",
    "productName": "Secure Site EV SSL",
    "organizationId": 516680,
    "organizationName": "Cert Testing Inc.",
    "profileType": "SENSOR",
    "divisionId": 677793,
    "emailAddresses": "cc.admin@cert-testing.com",
    "signatureHash": "sha256",
    "keySizeAndAlgorithm": "RSA 2048",
    "contacts": [
        {
            "contactId": 980122,
            "contactType": "org_contact"
        }
    ],
    "validityPeriod": "1Y",
    "orderCoverageLength": "2Y",
    "autoRenewSettings": {
        "daysBeforeExpiry": 30,
        "isAutoReplace": true
    },
    "forceAutoRenewSetting": false
}'

200 OK

{
    "error": null,
    "data": "Profile updated successfully"
}

Request parameters

Name	Req/Opt	Type	Description
accountId	required	string	Account ID.
id	required	integer	Automation profile ID.
userId	optional	integer	User ID.
name	required	string	Name of the profile.
profileState	optional	string	Status of the automation profile. Allowed values: `ACTIVE`, `ACTION_NEEDED`.
isDefault	optional	boolean	If `true`, sets the profile to be the default.
ctLogOption	optional	boolean	Use this option to enable CT logging for issued SSL certificates.
productType	required	string	Type of the product. Allowed values: See Glossary – Product identifiers.
productName	optional	string	Name of the product. Allowed values: See Glossary – Product identifiers.
organizationId	optional	integer	The ID of an existing organization to associate with the profile. To get the ID of organizations in your account, use the endpoint List organizations.
organizationName	optional	string	The name of the organization.
profileType	required	string	Type of profile. Allowed values: `ACME` or `SENSOR`
divisionId	required	string	Division ID.
emailAddresses	optional	string	Email address associated with the profile.
signatureHash	optional	string	Hash type ID for the algorithm used to sign the certificate. Allowed values: See Glossary – Hash types.
keySizeAndAlgorithm	optional	string	The key size and algorithm used to sign the certificate. Allowed values: `RSA 2048`, `RSA 4096`, `RSA 8192`, `ECC P256`, `ECC P384`
contacts	optional	array	Object container for automation profile contacts.
.. contactId	optional	integer	ID 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.
.. contactType	optional	string	Type of contact to add to the profile. Allowed values: `org_contact`, `technical_contact`, `ev_approver`
.. contactName	optional	string	Name of the contact.
customFields	optional^*	array	Account-specific custom fields. ^*Whether or not these fields are required depends on your custom field settings.
validityPeriod	required	string	Certificate validity. Allowed values: `1D`, `1Y` Ends with D – Day or Y - Year. Example: `1Y` Max value: 397 days
orderCoverageLength	optional	string	Selected order coverage plan. Possible values: 1Y, 2Y. Note: For accounts with Multi-year Plans enabled, allowed values range from `1Y` - `3Y`.
autoRenewSettings	optional	object	Object with auto-renew settings.
.. daysBeforeExpiry	optional	integer	Number of days before expiration to renew the certificate. Min: 1 day Max: Less than the certificate validity.
.. isAutoReplace	optional	boolean	If `true`, we automatically request and install a replacement certificate if the certificate discovered on the host is revoked or missing. Default: false
forceAutoRenewSetting	optional	boolean	If `true`, auto-renew settings are enabled. Default: false