Updating a Salesforce Cache-Only Key
Use PATCH /v1/cckm/sfdc/keys/{id}
to update a cache-only key, identified by its Resource ID. Not applicable for Salesforce BYOK Tenant Secret.
Syntax
curl -k 'https://<IP>/api/v1/cckm/sfdc/keys/{id}' -X PATCH -H 'Authorization: Bearer AUTHTOKEN' -H 'Content-Type: application/json' --data-binary $'{\n "sfdc_named_credential_id": "<salesforce_named_credential_id>",\n "certificate_id": "<salesforce_certificate_id>"\n}' --compressed
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
sfdc_named_credential_id | string | Salesforce named credential id. |
certificate_id | string | Certificate ID whose public key is used to encrypt the cache-only key. |
Example Request
curl -k 'https://thales.com/api/v1/cckm/sfdc/keys/a2c9f01e-48fd-4a82-bf40-918e581b3255' -X PATCH -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmZjhhMDM1ZS02NjExLTQ5ZWUtYWNmNC1lMzgwZTMxNGRhOTIiLCJzdWIiOiJsb2NhbHwzMTk0ZGY4Ny1kOTk2LTRjOGMtYWRmMi03MjNkZDA3NDY2YmIiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDNiYjk2NmQtYmRlOC00OWM5LTk0NzYtYzA5OTE4ODY0NjdjIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImI3MjhjYmQ2LTYzOGYtNGQ1ZC04N2Y1LTdlZmI4MGExMWVmNCIsImlhdCI6MTYzMzcwMDYyNywiZXhwIjoxNjMzNzAwOTI3fQ.ol0nsPMUpPozHGAMdEog8_aNiVXoaofM6nZpruBihRQ' -H 'Content-Type: application/json' --data-binary $'{\n "sfdc_named_credential_id": "00DB000000040bIMAQ",\n "certificate_id": "a2c9f01e-48fd-4a82-bf40-918e581b3255"\n}' --compressed
Example Response
{
"id": "a2c9f01e-48fd-4a82-bf40-918e581b3255",
"uri": "kylo:kylo:cckm:Tenant_Secret:a2c9f01e-48fd-4a82-bf40-918e581b3255",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2021-07-03T20:32:31.526936169Z",
"updatedAt": "2021-07-03T20:32:31.524915269Z",
"cloud_name": "sfdc",
"name": "IsaTS",
"organization_id": "a2c9f01e-48fd-4a82-bf40-918e581b3434",
"certificate_id": "04f63144-940c-4c4f-8426-333333333333",
"key_type": "cache-only",
"error_msg": "",
"sfdc_params": {
"created_by_id": "005B00000021BO4IAM",
"last_modified_date": "2021-07-03T20:32:31.000+0000",
"last_modified_by_id": "005B00000021BO4IAM",
"system_modstamp": "2021-07-03T20:32:31.000+0000",
"version": 2112,
"status": "ACTIVE",
"source": "REMOTE",
"type": "Data",
"remote_key_certificate": "cert1",
"remote_key_service_id": "00DB000000040bIMAQ",
"remote_key_identifier": "04f63144-940c-4c4f-8426-1917b54e0c33"
},
"source_key_tier": "local",
"source_key_id": "626fdff442284cf1ad4b9030c21bfcddb2004e1cfd2b420da7c33d7f50e78c91",
"source_key_name": "sfdc_key1"
}
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.