GET
/
api
/
svc
/
v1
/
secret-groups
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/secret-groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "fqn": "<string>",
      "name": "<string>",
      "tenantName": "<string>",
      "createdBySubject": {
        "subjectId": "<string>",
        "subjectType": "user",
        "subjectSlug": "<string>",
        "subjectDisplayName": "<string>"
      },
      "associatedSecrets": [
        {
          "id": "<string>",
          "fqn": "<string>",
          "name": "<string>",
          "secretGroupId": "<string>",
          "value": "<string>",
          "createdBySubject": {
            "subjectId": "<string>",
            "subjectType": "user",
            "subjectSlug": "<string>",
            "subjectDisplayName": "<string>"
          },
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "secretVersions": [
            {
              "id": "<string>",
              "fqn": "<string>",
              "value": "<string>",
              "version": 123,
              "secret": {},
              "secretId": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ],
          "activeDeploymentsCount": 123,
          "createdBy": "<string>"
        }
      ],
      "integrationId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "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
default:100

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
secretGroupId
string

Secret Group Id of secret group.

​
secretGroupFqn
string

Fqn of secret group.

​
secretAttributes
string

Attributes to return for secret object provided as comma separated values (secretAttributes=id,fqn)

​
secretGroupAttributes
string

Attributes returned for secret group object provided as comma separated values (secretGroupAttributes=id,fqn)

​
search
string

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.

The response is of type object.