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>",
    "notification_target": {
      "type": "email",
      "notification_channel": "<string>",
      "to_emails": [
        "<string>"
      ]
    },
    "tags": {},
    "identity_provider_mapping": [
      {
        "identity_provider": "<string>",
        "value": "<string>"
      }
    ]
  },
  "dryRun": false
}
'

import requests

url = "https://{controlPlaneURL}/api/svc/v1/virtual-accounts"

payload = {
    "manifest": {
        "name": "<string>",
        "type": "virtual-account",
        "permissions": [
            {
                "resource_fqn": "<string>",
                "resource_type": "<string>",
                "role_id": "<string>"
            }
        ],
        "expiration_date": "<string>",
        "notification_target": {
            "type": "email",
            "notification_channel": "<string>",
            "to_emails": ["<string>"]
        },
        "tags": {},
        "identity_provider_mapping": [
            {
                "identity_provider": "<string>",
                "value": "<string>"
            }
        ]
    },
    "dryRun": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    manifest: {
      name: '<string>',
      type: 'virtual-account',
      permissions: [{resource_fqn: '<string>', resource_type: '<string>', role_id: '<string>'}],
      expiration_date: '<string>',
      notification_target: {type: 'email', notification_channel: '<string>', to_emails: ['<string>']},
      tags: {},
      identity_provider_mapping: [{identity_provider: '<string>', value: '<string>'}]
    },
    dryRun: false
  })
};

fetch('https://{controlPlaneURL}/api/svc/v1/virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{controlPlaneURL}/api/svc/v1/virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'manifest' => [
        'name' => '<string>',
        'type' => 'virtual-account',
        'permissions' => [
                [
                                'resource_fqn' => '<string>',
                                'resource_type' => '<string>',
                                'role_id' => '<string>'
                ]
        ],
        'expiration_date' => '<string>',
        'notification_target' => [
                'type' => 'email',
                'notification_channel' => '<string>',
                'to_emails' => [
                                '<string>'
                ]
        ],
        'tags' => [
                
        ],
        'identity_provider_mapping' => [
                [
                                'identity_provider' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ],
    'dryRun' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{controlPlaneURL}/api/svc/v1/virtual-accounts"

	payload := strings.NewReader("{\n  \"manifest\": {\n    \"name\": \"<string>\",\n    \"type\": \"virtual-account\",\n    \"permissions\": [\n      {\n        \"resource_fqn\": \"<string>\",\n        \"resource_type\": \"<string>\",\n        \"role_id\": \"<string>\"\n      }\n    ],\n    \"expiration_date\": \"<string>\",\n    \"notification_target\": {\n      \"type\": \"email\",\n      \"notification_channel\": \"<string>\",\n      \"to_emails\": [\n        \"<string>\"\n      ]\n    },\n    \"tags\": {},\n    \"identity_provider_mapping\": [\n      {\n        \"identity_provider\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dryRun\": false\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{controlPlaneURL}/api/svc/v1/virtual-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"manifest\": {\n    \"name\": \"<string>\",\n    \"type\": \"virtual-account\",\n    \"permissions\": [\n      {\n        \"resource_fqn\": \"<string>\",\n        \"resource_type\": \"<string>\",\n        \"role_id\": \"<string>\"\n      }\n    ],\n    \"expiration_date\": \"<string>\",\n    \"notification_target\": {\n      \"type\": \"email\",\n      \"notification_channel\": \"<string>\",\n      \"to_emails\": [\n        \"<string>\"\n      ]\n    },\n    \"tags\": {},\n    \"identity_provider_mapping\": [\n      {\n        \"identity_provider\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dryRun\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{controlPlaneURL}/api/svc/v1/virtual-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"manifest\": {\n    \"name\": \"<string>\",\n    \"type\": \"virtual-account\",\n    \"permissions\": [\n      {\n        \"resource_fqn\": \"<string>\",\n        \"resource_type\": \"<string>\",\n        \"role_id\": \"<string>\"\n      }\n    ],\n    \"expiration_date\": \"<string>\",\n    \"notification_target\": {\n      \"type\": \"email\",\n      \"notification_channel\": \"<string>\",\n      \"to_emails\": [\n        \"<string>\"\n      ]\n    },\n    \"tags\": {},\n    \"identity_provider_mapping\": [\n      {\n        \"identity_provider\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dryRun\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
  },
  "token": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "code": 123,
  "details": [
    {}
  ]
}

{
  "statusCode": 123,
  "message": "<string>",
  "code": 123,
  "details": [
    {}
  ]
}

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>",
    "notification_target": {
      "type": "email",
      "notification_channel": "<string>",
      "to_emails": [
        "<string>"
      ]
    },
    "tags": {},
    "identity_provider_mapping": [
      {
        "identity_provider": "<string>",
        "value": "<string>"
      }
    ]
  },
  "dryRun": false
}
'

import requests

url = "https://{controlPlaneURL}/api/svc/v1/virtual-accounts"

payload = {
    "manifest": {
        "name": "<string>",
        "type": "virtual-account",
        "permissions": [
            {
                "resource_fqn": "<string>",
                "resource_type": "<string>",
                "role_id": "<string>"
            }
        ],
        "expiration_date": "<string>",
        "notification_target": {
            "type": "email",
            "notification_channel": "<string>",
            "to_emails": ["<string>"]
        },
        "tags": {},
        "identity_provider_mapping": [
            {
                "identity_provider": "<string>",
                "value": "<string>"
            }
        ]
    },
    "dryRun": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    manifest: {
      name: '<string>',
      type: 'virtual-account',
      permissions: [{resource_fqn: '<string>', resource_type: '<string>', role_id: '<string>'}],
      expiration_date: '<string>',
      notification_target: {type: 'email', notification_channel: '<string>', to_emails: ['<string>']},
      tags: {},
      identity_provider_mapping: [{identity_provider: '<string>', value: '<string>'}]
    },
    dryRun: false
  })
};

fetch('https://{controlPlaneURL}/api/svc/v1/virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{controlPlaneURL}/api/svc/v1/virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'manifest' => [
        'name' => '<string>',
        'type' => 'virtual-account',
        'permissions' => [
                [
                                'resource_fqn' => '<string>',
                                'resource_type' => '<string>',
                                'role_id' => '<string>'
                ]
        ],
        'expiration_date' => '<string>',
        'notification_target' => [
                'type' => 'email',
                'notification_channel' => '<string>',
                'to_emails' => [
                                '<string>'
                ]
        ],
        'tags' => [
                
        ],
        'identity_provider_mapping' => [
                [
                                'identity_provider' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ],
    'dryRun' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{controlPlaneURL}/api/svc/v1/virtual-accounts"

	payload := strings.NewReader("{\n  \"manifest\": {\n    \"name\": \"<string>\",\n    \"type\": \"virtual-account\",\n    \"permissions\": [\n      {\n        \"resource_fqn\": \"<string>\",\n        \"resource_type\": \"<string>\",\n        \"role_id\": \"<string>\"\n      }\n    ],\n    \"expiration_date\": \"<string>\",\n    \"notification_target\": {\n      \"type\": \"email\",\n      \"notification_channel\": \"<string>\",\n      \"to_emails\": [\n        \"<string>\"\n      ]\n    },\n    \"tags\": {},\n    \"identity_provider_mapping\": [\n      {\n        \"identity_provider\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dryRun\": false\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{controlPlaneURL}/api/svc/v1/virtual-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"manifest\": {\n    \"name\": \"<string>\",\n    \"type\": \"virtual-account\",\n    \"permissions\": [\n      {\n        \"resource_fqn\": \"<string>\",\n        \"resource_type\": \"<string>\",\n        \"role_id\": \"<string>\"\n      }\n    ],\n    \"expiration_date\": \"<string>\",\n    \"notification_target\": {\n      \"type\": \"email\",\n      \"notification_channel\": \"<string>\",\n      \"to_emails\": [\n        \"<string>\"\n      ]\n    },\n    \"tags\": {},\n    \"identity_provider_mapping\": [\n      {\n        \"identity_provider\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dryRun\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{controlPlaneURL}/api/svc/v1/virtual-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"manifest\": {\n    \"name\": \"<string>\",\n    \"type\": \"virtual-account\",\n    \"permissions\": [\n      {\n        \"resource_fqn\": \"<string>\",\n        \"resource_type\": \"<string>\",\n        \"role_id\": \"<string>\"\n      }\n    ],\n    \"expiration_date\": \"<string>\",\n    \"notification_target\": {\n      \"type\": \"email\",\n      \"notification_channel\": \"<string>\",\n      \"to_emails\": [\n        \"<string>\"\n      ]\n    },\n    \"tags\": {},\n    \"identity_provider_mapping\": [\n      {\n        \"identity_provider\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"dryRun\": false\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
  },
  "token": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "code": 123,
  "details": [
    {}
  ]
}

{
  "statusCode": 123,
  "message": "<string>",
  "code": 123,
  "details": [
    {}
  ]
}

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

The virtual account manifest describing the virtual account to create or update.

Show child attributes

dryRun

boolean | null

default:false

When true, validate the request without persisting any changes.

Response

The created or updated virtual account.

data

VirtualAccount · object

required

The requested virtual account.

Show child attributes

token

string | null

Authentication token for the virtual account. Present only on creation.

List virtual accounts Check virtual account exists

⌘I

TrueFoundry SDK

TrueFoundry CLI

Extras

Agent

Agent Skills

Applications

Metrics

Apply

Artifacts

Audit Logs

Clusters

Jobs

Logs

MCP Servers V2

MLRepos

Model Deployments

Models

Personal Access Tokens

Prompts

Provider Integrations

SCIM v2

Secret Groups

Secrets

Teams

Traces

Users

Virtual Accounts

Role Bindings

Workspaces

Create or update a virtual account

Authorizations

Body

Response