---
descriptions:
  object:
    self: 'The Vault [Object](/reference/vault/object).'
    id: Unique string ID of the object.
    name: 'Unique name of the object, used as the KV store key.'
    value: Plaintext data that will be stored in an encrypted format.
  object_metadata:
    self: 'The Vault Object [Metadata](/reference/vault/object/metadata).'
    context: Map of values used to determine the encryption key used.
    environment_id: ID of the WorkOS environment where the object was created.
    key_id: ID of the key used to encrypt the object.
    updated_at: ISO 8601 timestamp of the last modification to the object.
    updated_by:
      id: ID of the user or API key that last wrote to the object.
      name: >-
        Name of the user or [API key](/reference/api-authentication) that last
        wrote to the object.
    version_id: ID of the specific version of the object.
    version_check: >-
      ID of the expected version of the object. When this is set, the operation
      will fail if the current version is different than the one provided.
reference:
  curl:
    - url: /reference/vault/object
      key: object
      id: object
      title: object
      properties:
        - key: id
          type: string
          description: (object.id)
        - key: name
          type: string
          description: (object.name)
        - key: value
          type: string
          description: (object.value)
        - key: metadata
          type: object
          expanded: true
          properties:
            - key: id
              type: string
              description: (object.id)
            - key: environment_id
              type: string
              description: (object_metadata.environment_id)
            - key: context
              type: object
              description: (object_metadata.context)
            - key: key_id
              type: string
              description: (object_metadata.key_id)
            - key: updated_at
              type: string
              description: (object_metadata.updated_at)
            - key: updated_by
              type: object
              expanded: true
              properties:
                - key: id
                  type: string
                  description: (object_metadata.updated_by.id)
                - key: name
                  type: string
                  description: (object_metadata.updated_by.name)
            - key: version_id
              type: string
              description: (object_metadata.version_id)
  js:
    - url: /reference/vault/object
      key: Object
      id: object
      title: interface Object
      properties:
        - key: id
          type: string
          description: (object.id)
        - key: name
          type: string
          description: (object.name)
        - key: value
          type: string
          description: (object.value)
        - key: metadata
          type: object
          expanded: true
          properties:
            - key: id
              type: string
              description: (object.id)
            - key: environmentId
              type: string
              description: (object_metadata.environment_id)
            - key: context
              type: object
              description: (object_metadata.context)
            - key: keyId
              type: string
              description: (object_metadata.key_id)
            - key: updatedAt
              type: string
              description: (object_metadata.updated_at)
            - key: updatedBy
              type: object
              expanded: true
              properties:
                - key: id
                  type: string
                  description: (object_metadata.updated_by.id)
                - key: name
                  type: string
                  description: (object_metadata.updated_by.name)
            - key: versionId
              type: string
              description: (object_metadata.version_id)
  go:
    - url: /reference/vault/object
      key: Object
      id: object
      title: vault.Object
      properties:
        - key: Id
          type: string
          description: (object.id)
        - key: Name
          type: string
          description: (object.name)
        - key: Value
          type: string
          description: (object.value)
        - key: Metadata
          type: vault.ObjectMetadata
          expanded: true
          properties:
            - key: Id
              type: string
              description: (object.id)
            - key: EnvironmentId
              type: string
              description: (object_metadata.environment_id)
            - key: Context
              type: vault.KeyContext
              description: (object_metadata.context)
            - key: KeyId
              type: string
              description: (object_metadata.key_id)
            - key: UpdatedAt
              type: time.Time
              description: (object_metadata.updated_at)
            - key: UpdatedBy
              type: struct
              expanded: true
              properties:
                - key: Id
                  type: string
                  description: (object_metadata.updated_by.id)
                - key: Name
                  type: string
                  description: (object_metadata.updated_by.name)
            - key: VersionId
              type: string
              description: (object_metadata.version_id)
  python:
    - url: /reference/vault/object
      key: VaultObject
      id: object
      title: vault.VaultObject
      properties:
        - key: id
          type: str
          description: (object.id)
        - key: name
          type: str
          description: (object.name)
        - key: value
          type: str
          optional: true
          description: (object.value)
        - key: metadata
          type: vault.ObjectMetadata
          expanded: true
          properties:
            - key: id
              type: str
              description: (object.id)
            - key: environment_id
              type: str
              description: (object_metadata.environment_id)
            - key: context
              type: vault.KeyContext
              description: (object_metadata.context)
            - key: key_id
              type: str
              description: (object_metadata.key_id)
            - key: updated_at
              type: str
              description: (object_metadata.updated_at)
            - key: updated_by
              type: vault.ObjectUpdatedBy
              expanded: true
              properties:
                - key: id
                  type: str
                  description: (object_metadata.updated_by.id)
                - key: name
                  type: str
                  description: (object_metadata.updated_by.name)
            - key: version_id
              type: str
              description: (object_metadata.version_id)
originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/index.mdx
---

# Encrypted Object

Represents an encrypted object stored by Vault.

<CodeBlock title="Object" referenceId="object" file="object" />