Truefoundry Docs

Create or Update a Virtual Account

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": {
      "team": "<string>",
      "account": "<string>"
    }
  },
  "dryRun": true
}
'

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "tenantName": "<string>",
    "createdBySubject": {
      "subjectId": "<string>",
      "subjectType": "user",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "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>"
      }
    },
    "jwtId": "<string>",
    "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": {}
      }
    ],
    "accountId": "<string>",
    "metadata": {},
    "roleIds": [
      "<string>"
    ],
    "createdBy": "<string>",
    "nextScheduledRotation": "<string>"
  },
  "token": "<string>"
}

PUT

api

svc

virtual-accounts

Create or Update a Virtual Account

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": {
      "team": "<string>",
      "account": "<string>"
    }
  },
  "dryRun": true
}
'

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "tenantName": "<string>",
    "createdBySubject": {
      "subjectId": "<string>",
      "subjectType": "user",
      "subjectSlug": "<string>",
      "subjectDisplayName": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "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>"
      }
    },
    "jwtId": "<string>",
    "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": {}
      }
    ],
    "accountId": "<string>",
    "metadata": {},
    "roleIds": [
      "<string>"
    ],
    "createdBy": "<string>",
    "nextScheduledRotation": "<string>"
  },
  "token": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

manifest

VirtualAccountManifest · object

required

Virtual account manifest

Show child attributes

manifest.name

string

required

+label=Name +sort=1 +message=3 to 36 lower case characters long alphanumeric word, may contain - in between, cannot start with a number +usage=Virtual Account Name

manifest.type

enum<string>

required

+value=virtual-account

Available options:

virtual-account

manifest.permissions

Permissions · object[]

required

+label=Permissions +sort=2 +uiType=ServiceAccountPermissions

Show child attributes

manifest.permissions.resource_fqn

string

required

+label= Resource FQN +usage=The fully qualified name of the resource

manifest.permissions.resource_type

string

required

+label=Resource Type +usage=The type of the resource (cluster, workspace, etc.)

manifest.permissions.role_id

string

required

+label=Role ID +usage=The role id of the role to be assigned to the service account for that resource

manifest.expiration_date

string

+label=Expiration Date (UTC) +message=Expiration date of the virtual account +usage=Expiration Date of the Virtual Account (should be in the format yyyy-mm-dd) +sort=3 +uiType=DatePicker

manifest.auto_rotate

AutoRotate · object

+label=Enable Auto Rotation +sort=4 +usage=Enable Auto Rotation to automatically rotate the token +message=Enable Auto Rotation to automatically rotate the token +uiProps={"disableEdit":true}

Show child attributes

manifest.auto_rotate.auto_rotate_interval

integer

default:360

required

+label=Rotation Interval in days +sort=1 +usage=Rotation Interval in days after which the token will be rotated. Minimum value is 30.

Required range: x >= 30

manifest.auto_rotate.grace_period

integer

default:30

required

+label=Grace Period in days +sort=2 +usage=Grace Period in days for which the token will be valid after rotation interval. Minimum value is 1.

Required range: x >= 1

manifest.notification_target

NotificationTarget · object

+label=Email

NotificationTarget
NotificationTarget
NotificationTarget

Show child attributes

manifest.notification_target.type

enum<string>

required

+value=email

Available options:

email

manifest.notification_target.notification_channel

string

required

+label=Notification Channel +usage=Specify the notification channel to send alerts to +uiType=AlertNotificationChannel +uiProps={"integrationType":"notification-channel"} +sort=660

Minimum string length: 1

manifest.notification_target.to_emails

string[]

required

+label=To Emails +usage=List of recipients' email addresses if the notification channel is Email. +docs=Specify the emails to send alerts to +sort=665

Minimum string length: 1

manifest.secret_store_config

SecretStoreConfig · object

+label=Sync to Secret Manager +sort=6 +usage=Enable to store the virtual account token in a secret store +message=Enable to store the virtual account token in a secret store

Show child attributes

manifest.secret_store_config.integration_fqn

string

required

+label=Secret Store +usage=The secret store to store the virtual account token in +sort=1 +uiType=IntegrationSelect

manifest.secret_store_config.secret_path

string

required

+label=Secret Path +usage=The path where the virtual account token will be stored in the secret store (example: secret/path/to/virtual-account-token) +message=The path should only contain alphanumeric characters, hyphens, and slashes and it should start with a slash if giving the path containing slashes in between +sort=2

manifest.ownedBy

VirtualAccountOwnedBy · object

+label=Owner +usage=Names of the owners that own the virtual account

Show child attributes

manifest.ownedBy.team

string

required

+label=Team Name +sort=2 +usage=The name of the team that owns this resource +placeholder=Search Team +uiType=UserSelect +uiProps={"optionTypes": ["teams"], "maxAllowedUsers": 1}

manifest.ownedBy.account

string

+label=Account Name +sort=1 +usage=The name of the account that owns this resource +placeholder=Search Account +uiType=Hidden +uiProps={"maxAllowedAccounts": 1}

dryRun

boolean

Dry run

Response

Virtual account created/updated successfully

data

VirtualAccount · object

required

Virtual Account

Show child attributes

data.id

string

required

data.name

string

required

data.type

string

required

data.tenantName

string

required

data.createdBySubject

Subject · object

required

Show child attributes

data.createdBySubject.subjectId

string

required

Subject ID

data.createdBySubject.subjectType

enum<string>

required

Subject type

Available options:

user,

team,

serviceaccount,

virtualaccount,

external-identity

data.createdBySubject.subjectSlug

string

Subject slug

data.createdBySubject.subjectDisplayName

string

Subject display name

data.createdAt

string<date-time>

required

data.updatedAt

string<date-time>

required

data.manifest

VirtualAccountManifest · object

VirtualAccountManifest
PersonalAccessTokenManifest

Show child attributes

data.manifest.name

string

required

+label=Name +sort=1 +message=3 to 36 lower case characters long alphanumeric word, may contain - in between, cannot start with a number +usage=Virtual Account Name

data.manifest.type

enum<string>

required

+value=virtual-account

Available options:

virtual-account

data.manifest.permissions

Permissions · object[]

required

+label=Permissions +sort=2 +uiType=ServiceAccountPermissions

Show child attributes

data.manifest.permissions.resource_fqn

string

required

+label= Resource FQN +usage=The fully qualified name of the resource

data.manifest.permissions.resource_type

string

required

+label=Resource Type +usage=The type of the resource (cluster, workspace, etc.)

data.manifest.permissions.role_id

string

required

+label=Role ID +usage=The role id of the role to be assigned to the service account for that resource

data.manifest.expiration_date

string

+label=Expiration Date (UTC) +message=Expiration date of the virtual account +usage=Expiration Date of the Virtual Account (should be in the format yyyy-mm-dd) +sort=3 +uiType=DatePicker

data.manifest.auto_rotate

AutoRotate · object

+label=Enable Auto Rotation +sort=4 +usage=Enable Auto Rotation to automatically rotate the token +message=Enable Auto Rotation to automatically rotate the token +uiProps={"disableEdit":true}

Show child attributes

data.manifest.auto_rotate.auto_rotate_interval

integer

default:360

required

+label=Rotation Interval in days +sort=1 +usage=Rotation Interval in days after which the token will be rotated. Minimum value is 30.

Required range: x >= 30

data.manifest.auto_rotate.grace_period

integer

default:30

required

+label=Grace Period in days +sort=2 +usage=Grace Period in days for which the token will be valid after rotation interval. Minimum value is 1.

Required range: x >= 1

data.manifest.notification_target

NotificationTarget · object

+label=Email

NotificationTarget
NotificationTarget
NotificationTarget

Show child attributes

data.manifest.notification_target.type

enum<string>

required

+value=email

Available options:

email

data.manifest.notification_target.notification_channel

string

required

+label=Notification Channel +usage=Specify the notification channel to send alerts to +uiType=AlertNotificationChannel +uiProps={"integrationType":"notification-channel"} +sort=660

Minimum string length: 1

data.manifest.notification_target.to_emails

string[]

required

+label=To Emails +usage=List of recipients' email addresses if the notification channel is Email. +docs=Specify the emails to send alerts to +sort=665

Minimum string length: 1

data.manifest.secret_store_config

SecretStoreConfig · object

+label=Sync to Secret Manager +sort=6 +usage=Enable to store the virtual account token in a secret store +message=Enable to store the virtual account token in a secret store

Show child attributes

data.manifest.secret_store_config.integration_fqn

string

required

+label=Secret Store +usage=The secret store to store the virtual account token in +sort=1 +uiType=IntegrationSelect

data.manifest.secret_store_config.secret_path

string

required

data.manifest.ownedBy

VirtualAccountOwnedBy · object

+label=Owner +usage=Names of the owners that own the virtual account

Show child attributes

data.manifest.ownedBy.team

string

required

+label=Team Name +sort=2 +usage=The name of the team that owns this resource +placeholder=Search Team +uiType=UserSelect +uiProps={"optionTypes": ["teams"], "maxAllowedUsers": 1}

data.manifest.ownedBy.account

string

+label=Account Name +sort=1 +usage=The name of the account that owns this resource +placeholder=Search Account +uiType=Hidden +uiProps={"maxAllowedAccounts": 1}

data.jwtId

string

data.isExpired

boolean

data.jwts

Jwt · object[]

Show child attributes

data.jwts.id

string

required

data.jwts.subjectType

string

required

data.jwts.subjectId

string

required

data.jwts.expiry

string<date-time>

required

data.jwts.createdAt

string<date-time>

required

data.jwts.updatedAt

string<date-time>

required

data.jwts.metadata

object

data.accountId

string | null

data.metadata

object

data.roleIds

string[]

data.createdBy

string

data.nextScheduledRotation

string

token

string

Virtual Account token (present only when creating a virtual account)

List Virtual Accounts Get virtual account

⌘I

TrueFoundry SDK

TrueFoundry ML Client

Apply API Guides

Applications

Apply

Artifacts

Audit Logs

Clusters

Jobs

Logs

MLRepos

Model Deployments

Models

Personal Access Tokens

Prompts

Provider Integrations

Secret Groups

Secrets

Teams

Traces

Users

Virtual Accounts

Workspaces

Create or Update a Virtual Account

Authorizations

Body

Response