Represents an encrypted object stored by Vault.
{ "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "metadata": { "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "environment_id": "environment_example_23456789", "context": { "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" }, "key_id": "e2084ada-50c1-5f9a-b1c7-fa868d506e5a", "updated_at": "2025-02-21T12:04:09.165291Z", "updated_by": { "id": "user_01E4ZCR3C56J083X43JQXF3JK5", "name": "Marcelina Davis" }, "version_id": "Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X" }, "name": "secret-name", "value": "my secret value" }
const object = { id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', metadata: { id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', environmentId: 'environment_example_23456789', context: { organization_id: 'org_01EHZNVPK3SFK441A1RGBFSHRT', }, keyId: 'e2084ada-50c1-5f9a-b1c7-fa868d506e5a', updatedAt: '2025-02-21T12:04:09.165291Z', updatedBy: { id: 'user_01E4ZCR3C56J083X43JQXF3JK5', name: 'Marcelina Davis', }, versionId: 'Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X', }, name: 'secret-name', value: 'my secret value', };
from workos.types.vault import VaultObject, ObjectMetadata, KeyContext, ObjectUpdateBy vault_object = VaultObject( id="secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", metadata=ObjectMetadata( id="secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", environment_id="environment_example_23456789", context=KeyContext( organization_id="org_01EHZNVPK3SFK441A1RGBFSHRT", ), key_id="e2084ada-50c1-5f9a-b1c7-fa868d506e5a", updated_at="2025-02-21T12:04:09.165Z", updated_by=ObjectUpdateBy( id="user_01E4ZCR3C56J083X43JQXF3JK5", name="Marcelina Davis", ), version_id="Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", ), name="secret-name", value="my secret value", )
package main import ( "time" "github.com/workos/workos-go/v4/pkg/vault" ) func main() { object := vault.Object{ Id: "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", Metadata: vault.ObjectMetadata{ Id: "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", EnvironmentId: "environment_example_23456789", Context: vault.KeyContext{ "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT", }, KeyId: "e2084ada-50c1-5f9a-b1c7-fa868d506e5a", UpdatedAt: time.Now(), UpdatedBy: struct { Id string Name string }{ Id: "user_01E4ZCR3C56J083X43JQXF3JK5", Name: "Marcelina Davis", }, VersionId: "Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", }, Name: "secret-name", Value: "my secret value", } }
interface ObjectEncrypt and store a new key-value object.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.createObject({ name: 'secret-name', value: 'my secret value', context: { organizationId: 'org_01EHZNVPK3SFK441A1RGBFSHRT' }, });
{ "context": { "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" }, "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", "updated_at": "2024-06-15T10:30:00Z", "updated_by": { "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "name": "My API Key" }, "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" }
| curl --request POST \ | |
| --url "https://api.workos.com/vault/v1/kv" \ | |
| --header "Authorization: Bearer sk_example_123456789" \ | |
| --header "Content-Type: application/json" \ | |
| -d @- <<'BODY' | |
| { | |
| "key_context": { | |
| "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" | |
| }, | |
| "name": "my-secret", | |
| "value": "s3cr3t-v4lu3" | |
| } | |
| BODY |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.createObject({ | |
| name: 'secret-name', | |
| value: 'my secret value', | |
| context: { organizationId: 'org_01EHZNVPK3SFK441A1RGBFSHRT' }, | |
| }); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.vault.create_kv( | |
| key_context: { organization_id: "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" }, | |
| name: "my-secret", | |
| value: "s3cr3t-v4lu3" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.vault.create_kv( | |
| key_context={"organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P"}, | |
| name="my-secret", | |
| value="s3cr3t-v4lu3", | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Vault().CreateKv(context.Background(), &workos.VaultCreateKvParams{ | |
| KeyContext: map[string]any{"organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P"}, | |
| Name: "my-secret", | |
| Value: "s3cr3t-v4lu3", | |
| }) | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->vault() | |
| ->createKv( | |
| keyContext: ["organization_id" => "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P"], | |
| name: "my-secret", | |
| value: "s3cr3t-v4lu3", | |
| ); |
| import com.workos.WorkOS; | |
| import com.workos.vault.VaultApi.CreateKvOptions; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| CreateKvOptions options = | |
| CreateKvOptions.builder() | |
| .keyContext(Map.of("organization_id", "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P")) | |
| .name("my-secret") | |
| .value("s3cr3t-v4lu3") | |
| .build(); | |
| workos.vault.createKv(options); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Vault.CreateKvAsync(new VaultCreateKvOptions { | |
| KeyContext = | |
| new Dictionary<string, object> { | |
| { "organization_id", "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" }, | |
| }, | |
| Name = "my-secret", | |
| Value = "s3cr3t-v4lu3", | |
| }); |
| use workos::Client; | |
| use workos::vault::CreateKvParams; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .vault() | |
| .create_kv( | |
| CreateKvParams { | |
| key_context: serde_json::json!({ "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" }), | |
| name: "my-secret".into(), | |
| value: "s3cr3t-v4lu3".into(), | |
| ..Default::default() | |
| } | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "context": { | |
| "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" | |
| }, | |
| "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", | |
| "updated_at": "2024-06-15T10:30:00Z", | |
| "updated_by": { | |
| "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "name": "My API Key" | |
| }, | |
| "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" | |
| } |
POST/vaultReturns Fetch and decrypt an object by its unique identifier.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.readObject({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', });
{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "metadata": { "context": { "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" }, "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", "updated_at": "2024-06-15T10:30:00Z", "updated_by": { "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "name": "My API Key" }, "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" }, "name": "my-secret", "value": "s3cr3t-v4lu3" }
| curl "https://api.workos.com/vault/v1/kv/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.readObject({ | |
| id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', | |
| }); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.vault.get_kv(id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890") |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.vault.get_kv(id_="a1b2c3d4-e5f6-7890-abcd-ef1234567890") |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Vault().GetKv(context.Background(), "a1b2c3d4-e5f6-7890-abcd-ef1234567890") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos->vault()->getKv(id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.vault.getKv("a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Vault.GetKvAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .vault() | |
| .get_kv("a1b2c3d4-e5f6-7890-abcd-ef1234567890") | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "metadata": { | |
| "context": { | |
| "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" | |
| }, | |
| "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", | |
| "updated_at": "2024-06-15T10:30:00Z", | |
| "updated_by": { | |
| "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "name": "My API Key" | |
| }, | |
| "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" | |
| }, | |
| "name": "my-secret", | |
| "value": "s3cr3t-v4lu3" | |
| } |
GET/vaultParameters Returns Fetch and decrypt an object by its unique name.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.readObjectByName('my-secret-name');
{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "metadata": { "context": { "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" }, "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", "updated_at": "2024-06-15T10:30:00Z", "updated_by": { "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "name": "My API Key" }, "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" }, "name": "my-secret", "value": "s3cr3t-v4lu3" }
| curl "https://api.workos.com/vault/v1/kv/name/my-secret" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.readObjectByName('my-secret-name'); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.vault.get_name(name: "my-secret") |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.vault.get_name(name="my-secret") |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Vault().GetName(context.Background(), "my-secret") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos->vault()->getName(name: "my-secret"); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.vault.getName("my-secret"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Vault.GetNameAsync("my-secret"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .vault() | |
| .get_name("my-secret") | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "metadata": { | |
| "context": { | |
| "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" | |
| }, | |
| "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", | |
| "updated_at": "2024-06-15T10:30:00Z", | |
| "updated_by": { | |
| "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "name": "My API Key" | |
| }, | |
| "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" | |
| }, | |
| "name": "my-secret", | |
| "value": "s3cr3t-v4lu3" | |
| } |
GET/vaultParameters Returns Update the value of an existing encrypted object.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.updateObject({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', value: 'new value', versionCheck: 'Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X', });
{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "metadata": { "context": { "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" }, "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", "updated_at": "2024-06-15T10:30:00Z", "updated_by": { "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "name": "My API Key" }, "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" }, "name": "my-secret" }
| curl --request PUT \ | |
| --url "https://api.workos.com/vault/v1/kv/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ | |
| --header "Authorization: Bearer sk_example_123456789" \ | |
| --header "Content-Type: application/json" \ | |
| -d @- <<'BODY' | |
| { | |
| "value": "upd4t3d-v4lu3" | |
| } | |
| BODY |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.updateObject({ | |
| id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', | |
| value: 'new value', | |
| versionCheck: 'Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X', | |
| }); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.vault.update_kv( | |
| id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| value: "upd4t3d-v4lu3" | |
| ) |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.vault.update_kv( | |
| id_="a1b2c3d4-e5f6-7890-abcd-ef1234567890", value="upd4t3d-v4lu3" | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Vault().UpdateKv(context.Background(), "a1b2c3d4-e5f6-7890-abcd-ef1234567890", &workos.VaultUpdateKvParams{ | |
| Value: "upd4t3d-v4lu3", | |
| }) | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos | |
| ->vault() | |
| ->updateKv( | |
| id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| value: "upd4t3d-v4lu3", | |
| ); |
| import com.workos.WorkOS; | |
| import com.workos.vault.VaultApi.UpdateKvOptions; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| UpdateKvOptions options = UpdateKvOptions.builder().value("upd4t3d-v4lu3").build(); | |
| workos.vault.updateKv("a1b2c3d4-e5f6-7890-abcd-ef1234567890", options); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Vault.UpdateKvAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890", new VaultUpdateKvOptions { | |
| Value = "upd4t3d-v4lu3", | |
| }); |
| use workos::Client; | |
| use workos::vault::UpdateKvParams; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .vault() | |
| .update_kv( | |
| "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| UpdateKvParams { | |
| value: "upd4t3d-v4lu3".into(), | |
| ..Default::default() | |
| } | |
| ) | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "metadata": { | |
| "context": { | |
| "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" | |
| }, | |
| "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", | |
| "updated_at": "2024-06-15T10:30:00Z", | |
| "updated_by": { | |
| "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "name": "My API Key" | |
| }, | |
| "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" | |
| }, | |
| "name": "my-secret" | |
| } |
PUT/vaultParameters Returns Fetch metadata for an object without decrypting it.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.describeObject({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', });
{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "metadata": { "context": { "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" }, "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", "updated_at": "2024-06-15T10:30:00Z", "updated_by": { "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", "name": "My API Key" }, "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" }, "name": "my-secret" }
| curl "https://api.workos.com/vault/v1/kv/a1b2c3d4-e5f6-7890-abcd-ef1234567890/metadata" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.describeObject({ | |
| id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', | |
| }); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.vault.list_kv_metadata(id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890") |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.vault.list_kv_metadata(id_="a1b2c3d4-e5f6-7890-abcd-ef1234567890") |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Vault().ListKvMetadata(context.Background(), "a1b2c3d4-e5f6-7890-abcd-ef1234567890") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos->vault()->listKvMetadata(id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.vault.listKvMetadata("a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Vault.ListKvMetadataAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .vault() | |
| .list_kv_metadata("a1b2c3d4-e5f6-7890-abcd-ef1234567890") | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "metadata": { | |
| "context": { | |
| "organization_id": "org_01K8ZYT4AWJ6XP0E0S8CTBHE3P" | |
| }, | |
| "environment_id": "environment_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "key_id": "bf65e326-43a0-4b20-88c4-07ff3de5434c", | |
| "updated_at": "2024-06-15T10:30:00Z", | |
| "updated_by": { | |
| "id": "key_01K8ZYT4AWJ6XP0E0S8CTBHE3P", | |
| "name": "My API Key" | |
| }, | |
| "version_id": "c3d4e5f6-7890-abcd-ef12-34567890abcd" | |
| }, | |
| "name": "my-secret" | |
| } |
GET/vaultParameters Returns List all encrypted objects with cursor-based pagination.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.listObjects();
{ "data": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "my-secret", "updated_at": "2024-06-15T10:30:00Z" } ], "list_metadata": { "after": "b21f3a8c-7e4d-4b1a-9c5e-2d8f6a7b3c4e", "before": "a10e2b7d-6c3f-4a2b-8d1e-3f9a5b8c7d6e" } }
| curl "https://api.workos.com/vault/v1/kv" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.listObjects(); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.vault.list_kv |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.vault.list_kv() |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Vault().ListKv(context.Background()) | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos->vault()->listKv(); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.vault.listKv(); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Vault.ListKvAsync(); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .vault() | |
| .list_kv() | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "data": [ | |
| { | |
| "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", | |
| "name": "my-secret", | |
| "updated_at": "2024-06-15T10:30:00Z" | |
| } | |
| ], | |
| "list_metadata": { | |
| "after": "b21f3a8c-7e4d-4b1a-9c5e-2d8f6a7b3c4e", | |
| "before": "a10e2b7d-6c3f-4a2b-8d1e-3f9a5b8c7d6e" | |
| } | |
| } |
GET/vaultParameters Returns objectDelete an encrypted object.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.deleteObject({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', });
{ "name": "my-secret", "success": true }
| curl --request DELETE \ | |
| --url "https://api.workos.com/vault/v1/kv/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.deleteObject({ | |
| id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', | |
| }); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.vault.delete_kv(id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890") |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.vault.delete_kv(id_="a1b2c3d4-e5f6-7890-abcd-ef1234567890") |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Vault().DeleteKv(context.Background(), "a1b2c3d4-e5f6-7890-abcd-ef1234567890") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos->vault()->deleteKv(id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.vault.deleteKv("a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Vault.DeleteKvAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .vault() | |
| .delete_kv("a1b2c3d4-e5f6-7890-abcd-ef1234567890") | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "name": "my-secret", | |
| "success": true | |
| } |
DELETE/vaultParameters Returns Represents a static version of an object stored by Vault.
{ "created_at": "2025-02-21T12:04:09.165291Z", "current_version": true, "etag": "\"62b747b941ceefd67dacc026724044e4\"", "id": "Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", "size": 271 }
const objectVersion = { createdAt: '2025-02-21T12:04:09.165291Z', currentVersion: true, etag: '"62b747b941ceefd67dacc026724044e4"', id: 'Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X', size: 271, };
from workos.types.vault import ObjectVersion object_version = ObjectVersion( id="Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", current_version=True, created_at="2025-02-21T12:04:09.165291Z", )
package main import ( "time" "github.com/workos/workos-go/v4/pkg/vault" ) func main() { objectVersion := vault.ObjectVersion{ Id: "Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", CreatedAt: time.Now(), CurrentVersion: true, Etag: "\"62b747b941ceefd67dacc026724044e4\"", Size: 271, } }
Retrieve all versions for a specific object.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.listObjectVersions({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', });
{ "data": [ { "created_at": "2024-06-15T10:30:00Z", "current_version": true, "etag": "d41d8cd98f00b204e9800998ecf8427e", "id": "c3d4e5f6-7890-abcd-ef12-34567890abcd", "size": 256 } ], "list_metadata": { "after": "b21f3a8c-7e4d-4b1a-9c5e-2d8f6a7b3c4e", "before": "a10e2b7d-6c3f-4a2b-8d1e-3f9a5b8c7d6e" } }
| curl "https://api.workos.com/vault/v1/kv/a1b2c3d4-e5f6-7890-abcd-ef1234567890/versions" \ | |
| --header "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.listObjectVersions({ | |
| id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', | |
| }); |
| require "workos" | |
| WorkOS.configure do |config| | |
| config.api_key = "sk_example_123456789" | |
| end | |
| WorkOS.client.vault.list_kv_versions(id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890") |
| from workos import WorkOSClient | |
| client = WorkOSClient(api_key="sk_example_123456789", client_id="client_123456789") | |
| client.vault.list_kv_versions(id_="a1b2c3d4-e5f6-7890-abcd-ef1234567890") |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v9" | |
| ) | |
| func main() { | |
| client := workos.NewClient("sk_example_123456789") | |
| _, err := client.Vault().ListKvVersions(context.Background(), "a1b2c3d4-e5f6-7890-abcd-ef1234567890") | |
| if err != nil { | |
| panic(err) | |
| } | |
| } |
| <?php | |
| use WorkOS\WorkOS; | |
| $workos = new WorkOS( | |
| apiKey: "sk_example_123456789", | |
| clientId: "client_123456789", | |
| ); | |
| $workos->vault()->listKvVersions(id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| import com.workos.WorkOS; | |
| WorkOS workos = new WorkOS("sk_example_123456789"); | |
| workos.vault.listKvVersions("a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| using WorkOS; | |
| var client = new WorkOSClient(new WorkOSOptions { | |
| ApiKey = "sk_example_123456789", | |
| ClientId = "client_123456789", | |
| }); | |
| await client.Vault.ListKvVersionsAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890"); |
| use workos::Client; | |
| #[tokio::main] | |
| async fn main() -> Result<(), workos::Error> { | |
| let client = Client::builder() | |
| .api_key("sk_example_123456789") | |
| .client_id("client_123456789") | |
| .build(); | |
| let _result = client | |
| .vault() | |
| .list_kv_versions("a1b2c3d4-e5f6-7890-abcd-ef1234567890") | |
| .await?; | |
| Ok(()) | |
| } |
| { | |
| "data": [ | |
| { | |
| "created_at": "2024-06-15T10:30:00Z", | |
| "current_version": true, | |
| "etag": "d41d8cd98f00b204e9800998ecf8427e", | |
| "id": "c3d4e5f6-7890-abcd-ef12-34567890abcd", | |
| "size": 256 | |
| } | |
| ], | |
| "list_metadata": { | |
| "after": "b21f3a8c-7e4d-4b1a-9c5e-2d8f6a7b3c4e", | |
| "before": "a10e2b7d-6c3f-4a2b-8d1e-3f9a5b8c7d6e" | |
| } | |
| } |
GET/vaultParameters Returns object