Skip to main content
GET
/
api
/
svc
/
v1
/
virtual-accounts
List virtual accounts
curl --request GET \
  --url https://{controlPlaneURL}/api/svc/v1/virtual-accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "jqfwg345gi25n5ju2yz5iz6m",
      "type": "<string>",
      "tenantName": "<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",
      "accountId": "<string>",
      "manifest": {
        "name": "<string>",
        "type": "virtual-account",
        "permissions": [
          {
            "resource_fqn": "<string>",
            "resource_type": "<string>",
            "role_id": "<string>"
          }
        ],
        "expiration_date": "<string>",
        "auto_rotate": {
          "auto_rotate_interval": 360,
          "grace_period": 30
        },
        "notification_target": {
          "type": "email",
          "notification_channel": "<string>",
          "to_emails": [
            "<string>"
          ]
        },
        "secret_store_config": {
          "integration_fqn": "<string>",
          "secret_path": "<string>"
        },
        "ownedBy": {
          "team": "<string>",
          "account": "<string>"
        },
        "tags": {},
        "identity_provider_mapping": [
          {
            "identity_provider": "<string>",
            "value": "<string>"
          }
        ]
      },
      "jwtId": "<string>",
      "lastAccessedAt": "2023-11-07T05:31:56Z",
      "isExpired": true,
      "jwts": [
        {
          "id": "<string>",
          "subjectType": "<string>",
          "subjectId": "<string>",
          "expiry": "2023-11-07T05:31:56Z",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "metadata": {}
        }
      ],
      "metadata": {},
      "roleIds": [
        "<string>"
      ],
      "rolesWithResource": [
        {
          "roleId": "<string>",
          "resourceId": "<string>",
          "roleName": "<string>"
        }
      ],
      "createdBy": "<string>",
      "nextScheduledRotation": "<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

​
nameSearchQuery
string | null

Return virtual accounts with names that contain this string.

Example:

"staging-bot"

​
ownedByTeams
string[] | null

Comma-separated team names. Return virtual accounts owned by these teams.

Example:

"ml-team,infra-team"

​
isExpired
boolean | null

Filter by expiration status. true = expired only, false = not expired only.

​
filter
string | null

JSON string: structured filter tree (AND/OR groups, column leaves on name, json_map leaves on manifest.tags).

Example:

"{\"type\":\"AND\",\"children\":[{\"column\":\"name\",\"op\":\"STRING_CONTAINS\",\"value\":\"bot\"}]}"

Response

200 - application/json

Paginated list of virtual accounts the caller has access to.

​
data
VirtualAccount · object[]
required

Array of virtual accounts matching the query.

​
pagination
Pagination · object
required

Pagination metadata.