Get by ID

Returns the full shared secret object without revealing the secret value. Authentication is required for shared secrets that are scoped to an organization.

GET /api/v1/shared-secrets/{id}

cURL

cURL

curl --request GET \
  --url https://us.infisical.com/api/v1/shared-secrets/{id}

200

{
  "id": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isPasswordProtected": true,
  "isAuthorizedUser": true,
  "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",
  "identityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Path Parameters

id · string · required

The ID of the shared secret to retrieve.

Response

200

application/json

Default Response

id · string · required

expiresAt · string<date-time> · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

isPasswordProtected · boolean · required

Whether the shared secret is protected by a password.

isAuthorizedUser · boolean · required

Whether the current user is an authorized org member. If false, the user must provide a password.

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

identityId · string<uuid> | null