List Secret Groups

List the secret groups associated with a user along with the associated secrets for each group. Filtered with the options passed in the query fields. Note: This method does not return the secret values of the associatedSecrets in the response. A separate API call to /v1/secrets/{id} should be made to fetch the associated secret value.

GET /api/svc/v1/secret-groups

List Secret Groups

cURL

curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/secret-groups \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "tenantName": "<string>",
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>",
        "subjectPatName": "<string>",
        "subjectControllerName": "<string>",
        "subjectExternalIdentitySlug": "<string>"
      },
      "associatedSecrets": [
        {
          "id": "<string>",
          "fqn": "<string>",
          "name": "<string>",
          "secretGroupId": "<string>",
          "value": "<string>",
          "createdBySubject": {
            "subjectId": "<string>",
            "subjectSlug": "<string>",
            "subjectDisplayName": "<string>",
            "subjectPatName": "<string>",
            "subjectControllerName": "<string>",
            "subjectExternalIdentitySlug": "<string>"
          },
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "secretVersions": [
            {
              "id": "<string>",
              "fqn": "<string>",
              "value": "<string>",
              "version": 123,
              "secret": null,
              "secretId": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ],
          "activeDeploymentsCount": 123,
          "createdBy": "<string>"
        }
      ],
      "accountId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "fqn": "<string>",
      "integrationId": "<string>",
      "manifest": {},
      "createdBy": "<string>"
    }
  ],
  "pagination": {
    "total": 100,
    "offset": 0,
    "limit": 10
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer | null · default: 100

Number of items per page

Required range: 1 <= x <= 1000

Example:

10

offset · integer | null · default: 0

Number of items to skip

Required range: x >= 0

Example:

0

fqn · string | null

Fqn of secret group.

search · string | null

Search query - filters by secret group names that contain the search string

Response

200 - application/json

Returns all the secret groups associated with a user along with the associated secrets for each group.

data · SecretGroup · object[] · required

Array of Secret Groups

Show child attributes

pagination · Pagination · object · required

Pagination information

Show child attributes