Back to Infisical

Create

docs/api-reference/endpoints/secret-rotations/salesforce-oauth-credentials/create.mdx

0.160.53.4 KB
Original Source
<Note> Check out the configuration docs for [Salesforce OAuth Credentials Rotations](/documentation/platform/secret-rotation/salesforce-oauth-credentials) to learn how to obtain the required parameters. </Note>

Creates a Salesforce OAuth Credentials secret rotation. Infisical will rotate the consumer secret of the specified External Client App via your Salesforce connection and write the rotated consumer key/secret pair to the specified secret path.

Request body

FieldTypeRequiredDescription
namestringYesA unique, slug-friendly name for the rotation (max 100 characters).
projectIdstring (UUID)YesThe project ID.
connectionIdstring (UUID)YesID of the Salesforce app connection.
environmentstringYesEnvironment slug (e.g. dev, prod).
secretPathstringYesPath where the generated secrets will be stored.
isAutoRotationEnabledbooleanNoWhether to rotate automatically on the schedule. Defaults to true.
rotationIntervalnumberYesDays between rotations (minimum 1).
rotateAtUtcobjectNoTime of day (UTC) to run rotation: { "hours", "minutes" }. Defaults to { "hours": 0, "minutes": 0 }.
parameters.appIdstringYesThe identifier of the Salesforce External Client App to rotate the consumer secret for.
parameters.appNamestringYesThe developer name of the Salesforce External Client App to rotate the consumer secret for.
secretsMapping.consumerKeystringYesSecret key name to store the rotated consumer key (e.g. SALESFORCE_CONSUMER_KEY).
secretsMapping.consumerSecretstringYesSecret key name to store the rotated consumer secret (e.g. SALESFORCE_CONSUMER_SECRET).
descriptionstringNoOptional description.

Sample request

bash
curl --request POST \
  --url https://us.infisical.com/api/v2/secret-rotations/salesforce-oauth-credentials \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --data '{
    "name": "my-salesforce-rotation",
    "projectId": "<project-id>",
    "description": "Salesforce ECA consumer secret rotation",
    "connectionId": "<salesforce-connection-id>",
    "environment": "dev",
    "secretPath": "/",
    "isAutoRotationEnabled": true,
    "rotationInterval": 30,
    "rotateAtUtc": { "hours": 0, "minutes": 0 },
    "parameters": {
      "appId": "<external-client-app-id>",
      "appName": "<external-client-app-developer-name>"
    },
    "secretsMapping": {
      "consumerKey": "SALESFORCE_CONSUMER_KEY",
      "consumerSecret": "SALESFORCE_CONSUMER_SECRET"
    }
  }'

Sample response

json
{
  "secretRotation": {
    "id": "<rotation-id>",
    "name": "my-salesforce-rotation",
    "description": "Salesforce ECA consumer secret rotation",
    "secretsMapping": {
      "consumerKey": "SALESFORCE_CONSUMER_KEY",
      "consumerSecret": "SALESFORCE_CONSUMER_SECRET"
    },
    "isAutoRotationEnabled": true,
    "activeIndex": 0,
    "connectionId": "<salesforce-connection-id>",
    "rotationInterval": 30,
    "rotateAtUtc": { "hours": 0, "minutes": 0 },
    "type": "salesforce-oauth-credentials",
    "parameters": {
      "appId": "<external-client-app-id>",
      "appName": "<external-client-app-developer-name>"
    }
  }
}