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 ObjectCreate a new object, encrypted with the key(s) matching the provided key context.
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_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": "environment_example_23456789", "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "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" }
| curl "https://api.workos.com/vault/v1/kv" \ | |
| -X POST \ | |
| -H "Authorization: Bearer sk_example_123456789" \ | |
| -H "Content-Type: application/json" \ | |
| --data-raw \ | |
| '{ | |
| "name": "secret-name", | |
| "value": "my secret value", | |
| "key_context": { | |
| "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" | |
| } | |
| }' |
| 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' }, | |
| }); |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient(api_key="sk_example_123456789") | |
| object_metadata = workos_client.vault.create_object( | |
| name="secret-name", | |
| value="my secret value", | |
| key_context={"organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT"}, | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v4/pkg/vault" | |
| ) | |
| func main() { | |
| vault.SetAPIKey( | |
| "sk_example_123456789", | |
| ) | |
| objectMetadata, err := vault.CreateObject( | |
| context.Background(), | |
| vault.CreateObjectOpts{ | |
| Name: "secret-name", | |
| Value: "my secret value", | |
| KeyContext: vault.KeyContext{"organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT"}, | |
| }, | |
| ) | |
| } |
| { | |
| "context": { | |
| "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" | |
| }, | |
| "environment_id": "environment_example_23456789", | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "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" | |
| } |
vaultParameters objectReturns Get an existing object. The stored value will be decrypted and returned.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.readObject({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', });
{ "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "name": "secret-name", "value": "my secret value", "metadata": { "context": { "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": "environment_example_23456789", "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "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" } }
| curl "https://api.workos.com/vault/v1/kv/secret_51B0AC67C2FB4247AC5ABDDD3C701BDC" \ | |
| -H "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', | |
| }); |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient(api_key="sk_example_123456789") | |
| vault_object = workos_client.vault.read_object( | |
| object_id="secret_51B0AC67C2FB4247AC5ABDDD3C701BDC" | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v4/pkg/vault" | |
| ) | |
| func main() { | |
| vault.SetAPIKey( | |
| "sk_example_123456789", | |
| ) | |
| object, err := vault.ReadObject( | |
| context.Background(), | |
| vault.ReadObjectOpts{ | |
| Id: "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| }, | |
| ) | |
| } |
| { | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "name": "secret-name", | |
| "value": "my secret value", | |
| "metadata": { | |
| "context": { | |
| "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" | |
| }, | |
| "environment_id": "environment_example_23456789", | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "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" | |
| } | |
| } |
Get an existing object by its name. The stored value will be decrypted and returned.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.readObjectByName('my-secret-name');
{ "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "name": "secret-name", "value": "my secret value", "metadata": { "context": { "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": "environment_example_23456789", "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "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" } }
| curl "https://api.workos.com/vault/v1/kv/name/my-secret-name" \ | |
| -H "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'); |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient(api_key="sk_example_123456789") | |
| vault_object = workos_client.vault.read_object_by_name(name="my-secret-name") |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v4/pkg/vault" | |
| ) | |
| func main() { | |
| vault.SetAPIKey( | |
| "sk_example_123456789", | |
| ) | |
| object, err := vault.ReadObjectByName( | |
| context.Background(), | |
| vault.ReadObjectByNameOpts{ | |
| Name: "my-secret-name", | |
| }, | |
| ) | |
| } |
| { | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "name": "secret-name", | |
| "value": "my secret value", | |
| "metadata": { | |
| "context": { | |
| "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" | |
| }, | |
| "environment_id": "environment_example_23456789", | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "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" | |
| } | |
| } |
Update the value for an object. The key context of the original object will be used to encrypt the new data.
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": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "name": "secret-name", "metadata": { "context": { "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": "environment_example_23456789", "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "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" } }
| curl "https://api.workos.com/vault/v1/kv/secret_51B0AC67C2FB4247AC5ABDDD3C701BDC" \ | |
| -X PUT \ | |
| -H "Authorization: Bearer sk_example_123456789" \ | |
| -H "Content-Type: application/json" \ | |
| --data-raw \ | |
| '{ | |
| "value": "my secret value", | |
| "version_check": ""Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X" | |
| }' |
| 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', | |
| }); |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient(api_key="sk_example_123456789") | |
| updated_object = workos_client.vault.update_object( | |
| object_id="secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| value="new value", | |
| version_check="Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v4/pkg/vault" | |
| ) | |
| func main() { | |
| vault.SetAPIKey( | |
| "sk_example_123456789", | |
| ) | |
| object, err := vault.UpdateObject( | |
| context.Background(), | |
| vault.UpdateObjectOpts{ | |
| Id: "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| Value: "new value", | |
| VersionCheck: "Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", | |
| }, | |
| ) | |
| } |
| { | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "name": "secret-name", | |
| "metadata": { | |
| "context": { | |
| "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" | |
| }, | |
| "environment_id": "environment_example_23456789", | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "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" | |
| } | |
| } |
Retrieve metadata about an object. The value itself is not returned.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.describeObject({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', });
{ "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "name": "secret-name", "metadata": { "context": { "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" }, "environment_id": "environment_example_23456789", "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "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" } }
| curl "https://api.workos.com/vault/v1/kv/secret_51B0AC67C2FB4247AC5ABDDD3C701BDC/metadata" \ | |
| -H "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', | |
| }); |
| # Describe object is not currently supported by the WorkOS Python SDK |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v4/pkg/vault" | |
| ) | |
| func main() { | |
| vault.SetAPIKey( | |
| "sk_example_123456789", | |
| ) | |
| object, err := vault.DescribeObject( | |
| context.Background(), | |
| vault.ReadObjectOpts{ | |
| Id: "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| }, | |
| ) | |
| } |
| { | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "name": "secret-name", | |
| "metadata": { | |
| "context": { | |
| "organization_id": "org_01EHZNVPK3SFK441A1RGBFSHRT" | |
| }, | |
| "environment_id": "environment_example_23456789", | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "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" | |
| } | |
| } |
Get list of object names stored in Vault.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.listObjects();
{ "data": [ { "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", "name": "secret-name", "updated_at": "2025-02-21T12:04:09.000000Z" }, { "id": "secret_60B446F845B55648AA98CD584E1FBD44", "name": "another secret", "updated_at": "2025-02-21T15:12:23.000000Z" }, { "id": "secret_6FC121802E0E5A029350874EFB117886", "name": "org_abc123 pii", "updated_at": "2025-02-23T03:44:54.000000Z" } ], "list_metadata": { "before": "secret_6FC121802E0E5A029350874EFB117886", "after": null } }
| curl https://api.workos.com/vault/v1/kv \ | |
| -H "Authorization: Bearer sk_example_123456789" |
| import { WorkOS } from '@workos-inc/node'; | |
| const workos = new WorkOS('sk_example_123456789'); | |
| await workos.vault.listObjects(); |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient(api_key="sk_example_123456789") | |
| # List objects | |
| paginated_objects = workos_client.vault.list_objects() | |
| # List objects with pagination parameters | |
| paginated_objects = workos_client.vault.list_objects( | |
| limit=5, after="secret_51B0AC67C2FB4247AC5ABDDD3C701BDC" | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v4/pkg/vault" | |
| ) | |
| func main() { | |
| vault.SetAPIKey( | |
| "sk_example_123456789", | |
| ) | |
| listResponse, err := vault.ListObjects( | |
| context.Background(), | |
| vault.ListObjectsOpts{}, | |
| ) | |
| } |
| { | |
| "data": [ | |
| { | |
| "id": "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| "name": "secret-name", | |
| "updated_at": "2025-02-21T12:04:09.000000Z" | |
| }, | |
| { | |
| "id": "secret_60B446F845B55648AA98CD584E1FBD44", | |
| "name": "another secret", | |
| "updated_at": "2025-02-21T15:12:23.000000Z" | |
| }, | |
| { | |
| "id": "secret_6FC121802E0E5A029350874EFB117886", | |
| "name": "org_abc123 pii", | |
| "updated_at": "2025-02-23T03:44:54.000000Z" | |
| } | |
| ], | |
| "list_metadata": { | |
| "before": "secret_6FC121802E0E5A029350874EFB117886", | |
| "after": null | |
| } | |
| } |
vaultParameters objectReturns objectPermanently delete an object.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.deleteObject({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', });
{ "success": true, "name": "secret-name" }
| curl "https://api.workos.com/vault/v1/kv/secret_51B0AC67C2FB4247AC5ABDDD3C701BDC" \ | |
| -X DELETE \ | |
| -H "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', | |
| }); |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient(api_key="sk_example_123456789") | |
| workos_client.vault.delete_object(object_id="secret_51B0AC67C2FB4247AC5ABDDD3C701BDC") |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v4/pkg/vault" | |
| ) | |
| func main() { | |
| vault.SetAPIKey( | |
| "sk_example_123456789", | |
| ) | |
| response, err := vault.DeleteObject( | |
| context.Background(), | |
| vault.DeleteObjectOpts{ | |
| Id: "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| }, | |
| ) | |
| } |
| { | |
| "success": true, | |
| "name": "secret-name" | |
| } |
vaultParameters objectReturns 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, } }
Get list of versions for an object stored in Vault.
import { WorkOS } from '@workos-inc/node'; const workos = new WorkOS('sk_example_123456789'); await workos.vault.listObjectVersions({ id: 'secret_51B0AC67C2FB4247AC5ABDDD3C701BDC', });
{ "data": [ { "created_at": "2025-02-21T12:04:09.165291Z", "current_version": true, "etag": "\"62b747b941ceefd67dacc026724044e4\"", "id": "Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", "size": 271 }, { "created_at": "2025-02-04T02:07:31.264189Z", "current_version": false, "etag": "\"7283fe4ac9609be1686bc8e79486d212\"", "id": "PpVeG_pxIeFuHZ00_ZqcK1SaiPMK7mkr", "size": 230 } ], "list_metadata": { "before": "PpVeG_pxIeFuHZ00_ZqcK1SaiPMK7mkr", "after": null } }
| curl "https://api.workos.com/vault/v1/kv/secret_51B0AC67C2FB4247AC5ABDDD3C701BDC/versions" \ | |
| -H "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', | |
| }); |
| from workos import WorkOSClient | |
| workos_client = WorkOSClient(api_key="sk_example_123456789") | |
| object_versions = workos_client.vault.list_object_versions( | |
| object_id="secret_51B0AC67C2FB4247AC5ABDDD3C701BDC" | |
| ) |
| package main | |
| import ( | |
| "context" | |
| "github.com/workos/workos-go/v4/pkg/vault" | |
| ) | |
| func main() { | |
| vault.SetAPIKey( | |
| "sk_example_123456789", | |
| ) | |
| listResponse, err := vault.ListObjectVersions( | |
| context.Background(), | |
| vault.ReadObjectOpts{ | |
| Id: "secret_51B0AC67C2FB4247AC5ABDDD3C701BDC", | |
| }, | |
| ) | |
| } |
| { | |
| "data": [ | |
| { | |
| "created_at": "2025-02-21T12:04:09.165291Z", | |
| "current_version": true, | |
| "etag": "\"62b747b941ceefd67dacc026724044e4\"", | |
| "id": "Wq49AmJIR7QI0kSwfY9BZ6vNsOq6AO_X", | |
| "size": 271 | |
| }, | |
| { | |
| "created_at": "2025-02-04T02:07:31.264189Z", | |
| "current_version": false, | |
| "etag": "\"7283fe4ac9609be1686bc8e79486d212\"", | |
| "id": "PpVeG_pxIeFuHZ00_ZqcK1SaiPMK7mkr", | |
| "size": 230 | |
| } | |
| ], | |
| "list_metadata": { | |
| "before": "PpVeG_pxIeFuHZ00_ZqcK1SaiPMK7mkr", | |
| "after": null | |
| } | |
| } |
vaultParameters objectReturns object