Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
curl --request PUT \
  --url https://{controlPlaneURL}/api/svc/v1/virtual-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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": {
      "account": "<string>",
      "team": "<string>"
    }
  },
  "dryRun": true
}'{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "tenantName": "<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": {
        "account": "<string>",
        "team": "<string>"
      }
    },
    "jwtId": "<string>",
    "createdBySubject": {
      "subjectId": "<string>",
      "subjectType": "user",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isExpired": true,
    "jwts": [
      {
        "id": "<string>",
        "subjectType": "<string>",
        "subjectId": "<string>",
        "metadata": {},
        "expiry": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "accountId": "<string>",
    "createdBy": "<string>",
    "nextScheduledRotation": "<string>"
  },
  "token": "<string>"
}Creates a new virtual account or updates an existing one based on the provided manifest.
curl --request PUT \
  --url https://{controlPlaneURL}/api/svc/v1/virtual-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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": {
      "account": "<string>",
      "team": "<string>"
    }
  },
  "dryRun": true
}'{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "tenantName": "<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": {
        "account": "<string>",
        "team": "<string>"
      }
    },
    "jwtId": "<string>",
    "createdBySubject": {
      "subjectId": "<string>",
      "subjectType": "user",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isExpired": true,
    "jwts": [
      {
        "id": "<string>",
        "subjectType": "<string>",
        "subjectId": "<string>",
        "metadata": {},
        "expiry": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "accountId": "<string>",
    "createdBy": "<string>",
    "nextScheduledRotation": "<string>"
  },
  "token": "<string>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Was this page helpful?