Access

Access a shared secret by its ID. If the secret is password protected, you must provide the password in the request body. Returns the secret value if access is granted, or an error if access is denied. The endpoint requires authentication if the shared secret is scoped to an organization.

POST /api/v1/shared-secrets/{id}/access

cURL

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/shared-secrets/{id}/access \
  --header 'Content-Type: application/json' \
  --data '
{
  "password": "<string>"
}
'

200

{
  "id": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expiresAfterViews": 123,
  "accessType": "anyone",
  "name": "<string>",
  "lastViewedAt": "2023-11-07T05:31:56Z",
  "type": "share",
  "authorizedEmails": null,
  "identityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "allowExternalEmails": false,
  "orgName": "<string>",
  "secretValue": "<string>"
}

Path Parameters

id · string · required

The ID of the shared secret to access.

Body

application/json

password · string

The password for accessing a password-protected shared secret. Only required if the secret is password protected.

Response

200

application/json

Default Response

id · string · required

expiresAt · string<date-time> · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

userId · string<uuid> | null

orgId · string<uuid> | null

expiresAfterViews · number | null

accessType · string · default: anyone

name · string | null

lastViewedAt · string<date-time> | null

type · string · default: share

authorizedEmails · unknown

identityId · string<uuid> | null

allowExternalEmails · boolean | null · default: false

orgName · string

secretValue · string