Documentation for location element

Annotations

Description  Represents a request that was made to the API. Including what Token was used and what resource was accessed.

Diagram

Type

object

Properties

Name	Occurrence
requestId timestamp action result actor resource	optional optional optional optional optional optional

Source


 "APIRequest": {
  "type": "object",
  "description": "Represents a request that was made to the API. Including what Token was used and what resource was accessed.",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "The unique id used to identify a single request."
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The time at which the request was processed by the server.",
      "readOnly": true
    },
    "action": {
      "type": "string",
      "enum": [
        "READ",
        "DELETE",
        "CREATE",
        "UPDATE"
      ]
    },
    "result": {
      "type": "string",
      "enum": [
        "SUCCESS",
        "DENY"
      ]
    },
    "actor": {
      "type": "object",
      "properties": {}
    },
    "resource": {
      "type": "object",
      "properties": {}
    }
  }
}

Annotations

Description  The unique id used to identify a single request.

Diagram

Type

string

Source


 "requestId": {
  "type": "string",
  "description": "The unique id used to identify a single request."
}

Annotations

Description  The time at which the request was processed by the server.

Diagram

Type

string

Constraints

Format : date-time

Source


 "timestamp": {
  "type": "string",
  "format": "date-time",
  "description": "The time at which the request was processed by the server.",
  "readOnly": true
}

Diagram

Type

string

Enumeration

Values

READ

DELETE

CREATE

UPDATE

Source


 "action": {
  "type": "string",
  "enum": [
    "READ",
    "DELETE",
    "CREATE",
    "UPDATE"
  ]
}

Diagram

Type

string

Enumeration

Values

SUCCESS

DENY

Source


 "result": {
  "type": "string",
  "enum": [
    "SUCCESS",
    "DENY"
  ]
}

Diagram

Type

object

Properties

Name	Occurrence
id account jti userAgent requestIp	optional optional optional optional optional

Source


 "actor": {
  "type": "object",
  "properties": {
    "id": {"type": "string"},
    "account": {"type": "string"},
    "jti": {"type": "string"},
    "userAgent": {"type": "string"},
    "requestIp": {"type": "string"}
  }
}

Diagram

Type

string

Source


 "id": {"type": "string"}

Diagram

Type

string

Source


 "account": {"type": "string"}

Diagram

Type

string

Source


 "jti": {"type": "string"}

Diagram

Type

string

Source


 "userAgent": {"type": "string"}

Diagram

Type

string

Source


 "requestIp": {"type": "string"}

Diagram

Type

object

Properties

Name	Occurrence
type vault item itemVersion	optional optional optional optional

Source


 "resource": {
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "ITEM",
        "VAULT"
      ]
    },
    "vault": {
      "type": "object",
      "properties": {}
    },
    "item": {
      "type": "object",
      "properties": {}
    },
    "itemVersion": {"type": "integer"}
  }
}

Diagram

Type

string

Enumeration

Values

ITEM

VAULT

Source


 "type": {
  "type": "string",
  "enum": [
    "ITEM",
    "VAULT"
  ]
}

Diagram

Type

object

Properties

Name	Occurrence
id	optional

Source


 "vault": {
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[\\da-z]{26}"
    }
  }
}

Diagram

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


 "id": {
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Diagram

Type

object

Properties

Name	Occurrence
id	optional

Source


 "item": {
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[\\da-z]{26}"
    }
  }
}

Diagram

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


 "id": {
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Diagram

Type

number

Source


 "itemVersion": {"type": "integer"}

Diagram

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


 "id": {
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Diagram

Type

string

Source


 "title": {"type": "string"}

Diagram

Type

object

Properties

Name	Occurrence
id	required

Source


 "vault": {
  "type": "object",
  "required": ["id"],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[\\da-z]{26}"
    }
  }
}

Diagram

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


 "id": {
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Diagram

Type

string

Enumeration

Values

SOCIAL_SECURITY_NUMBER

SECURE_NOTE

OUTDOOR_LICENSE

WIRELESS_ROUTER

API_CREDENTIAL

DRIVER_LICENSE

EMAIL_ACCOUNT

CREDIT_CARD

IDENTITY

MEMBERSHIP

SOFTWARE_LICENSE

BANK_ACCOUNT

PASSWORD

DATABASE

SERVER

CUSTOM

DOCUMENT

REWARD_PROGRAM

PASSPORT

Source


 "category": {
  "type": "string",
  "enum": [
    "SOCIAL_SECURITY_NUMBER",
    "SECURE_NOTE",
    "OUTDOOR_LICENSE",
    "WIRELESS_ROUTER",
    "API_CREDENTIAL",
    "DRIVER_LICENSE",
    "EMAIL_ACCOUNT",
    "CREDIT_CARD",
    "IDENTITY",
    "MEMBERSHIP",
    "SOFTWARE_LICENSE",
    "BANK_ACCOUNT",
    "PASSWORD",
    "DATABASE",
    "SERVER",
    "CUSTOM",
    "DOCUMENT",
    "LOGIN",
    "REWARD_PROGRAM",
    "PASSPORT"
  ]
}

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

#/properties/urls/items

Source


 "urls": {
  "type": "array",
  "example": [
    {
      "primary": true,
      "href": "https://example.com"
    },
    {"href": "https://example.org"}
  ],
  "items": {
    "type": "object",
    "required": ["href"],
    "properties": {
      "primary": {"type": "boolean"},
      "href": {"type": "string"}
    }
  }
}

Diagram

Type

object

Properties

Name	Occurrence
primary href	optional required

Source


 "items": {
  "type": "object",
  "required": ["href"],
  "properties": {
    "primary": {"type": "boolean"},
    "href": {"type": "string"}
  }
}

Diagram

Type

boolean

Source


 "primary": {"type": "boolean"}

Diagram

Type

string

Source


 "href": {"type": "string"}

Diagram

Type

boolean

Default value :

false

Source


 "favorite": {
  "default": false,
  "type": "boolean"
}

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

#/properties/tags/items

Source


 "tags": {
  "type": "array",
  "items": {"type": "string"}
}

Diagram

Type

string

Source


 "items": {"type": "string"}

Diagram

Type

number

Source


 "version": {"type": "integer"}

Diagram

Type

string

Enumeration

Values

ARCHIVED

DELETED

Source


 "state": {
  "readOnly": true,
  "type": "string",
  "enum": [
    "ARCHIVED",
    "DELETED"
  ]
}

Diagram

Type

string

Constraints

Format : date-time

Source


 "createdAt": {
  "type": "string",
  "format": "date-time",
  "readOnly": true
}

Diagram

Type

string

Constraints

Format : date-time

Source


 "updatedAt": {
  "type": "string",
  "format": "date-time",
  "readOnly": true
}

Diagram

Type

string

Source


 "lastEditedBy": {
  "type": "string",
  "readOnly": true
}

Diagram

Type

object

Properties

Name	Occurrence
id section type purpose label value generate recipe entropy	required optional required optional optional optional optional optional optional

Source


 "Field": {
  "type": "object",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {"type": "string"},
    "section": {
      "type": "object",
      "properties": {}
    },
    "type": {
      "default": "STRING",
      "type": "string",
      "enum": [
        "TOTP",
        "DATE",
        "MONTH_YEAR",
        "CONCEALED",
        "STRING",
        "MENU",
        "EMAIL",
        "URL"
      ]
    },
    "purpose": {
      "description": "Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.",
      "type": "string",
      "enum": [
        "",
        "NOTES",
        "PASSWORD",
        "USERNAME"
      ]
    },
    "label": {"type": "string"},
    "value": {"type": "string"},
    "generate": {
      "description": "If value is not present then a new value should be generated for this field",
      "default": false,
      "type": "boolean"
    },
    "recipe": {"ref": "#/components/schemas/GeneratorRecipe"},
    "entropy": {
      "type": "number",
      "description": "For fields with a purpose of `PASSWORD` this is the entropy of the value",
      "readOnly": true
    }
  }
}

Diagram

Type

string

Source


 "id": {"type": "string"}

Diagram

Type

object

Properties

Name	Occurrence
id	optional

Source


 "section": {
  "type": "object",
  "properties": {
    "id": {"type": "string"}
  }
}

Diagram

Type

string

Source


 "id": {"type": "string"}

Diagram

Type

string

Constraints

Default : STRING

Enumeration

Values

TOTP

DATE

MONTH_YEAR

CONCEALED

STRING

URL

Source


 "type": {
  "default": "STRING",
  "type": "string",
  "enum": [
    "TOTP",
    "DATE",
    "MONTH_YEAR",
    "CONCEALED",
    "STRING",
    "MENU",
    "EMAIL",
    "URL"
  ]
}

Annotations

Description  Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.

Diagram

Type

string

Enumeration

Values

NOTES

PASSWORD

USERNAME

Source


 "purpose": {
  "description": "Some item types, Login and Password, have fields used for autofill. This property indicates that purpose and is required for some item types.",
  "type": "string",
  "enum": [
    "",
    "NOTES",
    "PASSWORD",
    "USERNAME"
  ]
}

Diagram

Type

string

Source


 "label": {"type": "string"}

Diagram

Type

string

Source


 "value": {"type": "string"}

Annotations

Description  If value is not present then a new value should be generated for this field

Diagram

Type

boolean

Default value :

false

Source


 "generate": {
  "description": "If value is not present then a new value should be generated for this field",
  "default": false,
  "type": "boolean"
}

Diagram

Type

empty schema

Source


 "recipe": {"ref": "#/components/schemas/GeneratorRecipe"}

Annotations

Description  For fields with a purpose of `PASSWORD` this is the entropy of the value

Diagram

Type

number

Source


 "entropy": {
  "type": "number",
  "description": "For fields with a purpose of `PASSWORD` this is the entropy of the value",
  "readOnly": true
}

Diagram

Type

object

All of

Choices

FullItem : Schema (0)

FullItem : Schema (1)

Source


 "FullItem": {
  "allOf": [
    {"ref": "#/components/schemas/Item"},
    {
      "type": "object",
      "properties": {
        "sections": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {"type": "string"},
              "label": {"type": "string"}
            }
          }
        },
        "fields": {
          "type": "array",
          "items": {"ref": "#/components/schemas/Field"}
        },
        "files": {
          "type": "array",
          "items": {"ref": "#/components/schemas/File"}
        }
      }
    }
  ]
}

Diagram

Type

empty schema

Source


{"ref": "#/components/schemas/Item"}

Diagram

Type

object

Properties

Name	Occurrence
sections fields files	optional optional optional

Source


{
  "type": "object",
  "properties": {
    "sections": {
      "type": "array",
      "items": {}
    },
    "fields": {
      "type": "array",
      "items": {}
    },
    "files": {
      "type": "array",
      "items": {}
    }
  }
}

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

#/properties/FullItem/allOf/1/properties/sections/items

Source


 "sections": {
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {"type": "string"},
      "label": {"type": "string"}
    }
  }
}

Diagram

Type

object

Properties

Name	Occurrence
id label	optional optional

Source


 "items": {
  "type": "object",
  "properties": {
    "id": {"type": "string"},
    "label": {"type": "string"}
  }
}

Diagram

Type

string

Source


 "id": {"type": "string"}

Diagram

Type

string

Source


 "label": {"type": "string"}

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

#/properties/FullItem/allOf/1/properties/fields/items

Source


 "fields": {
  "type": "array",
  "items": {"ref": "#/components/schemas/Field"}
}

Diagram

Type

empty schema

Source


 "items": {"ref": "#/components/schemas/Field"}

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

#/properties/FullItem/allOf/1/properties/files/items

Source


 "files": {
  "type": "array",
  "items": {"ref": "#/components/schemas/File"}
}

Diagram

Type

empty schema

Source


 "items": {"ref": "#/components/schemas/File"}

Diagram

Type

object

Properties

Name	Occurrence
id name description attributeVersion contentVersion items type createdAt updatedAt	optional optional optional optional optional optional optional optional optional

Source


 "Vault": {
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[\\da-z]{26}"
    },
    "name": {"type": "string"},
    "description": {"type": "string"},
    "attributeVersion": {
      "type": "integer",
      "description": "The vault version"
    },
    "contentVersion": {
      "type": "integer",
      "description": "The version of the vault contents"
    },
    "items": {
      "type": "integer",
      "description": "Number of active items in the vault"
    },
    "type": {
      "type": "string",
      "enum": [
        "PERSONAL",
        "TRANSFER",
        "USER_CREATED",
        "EVERYONE"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  }
}

Diagram

Type

string

Constraints

Pattern : ^[\da-z]{26}

Source


 "id": {
  "type": "string",
  "pattern": "^[\\da-z]{26}"
}

Diagram

Type

string

Source


 "name": {"type": "string"}

Diagram

Type

string

Source


 "description": {"type": "string"}

Annotations

Description  The vault version

Diagram

Type

number

Source


 "attributeVersion": {
  "type": "integer",
  "description": "The vault version"
}

Annotations

Description  The version of the vault contents

Diagram

Type

number

Source


 "contentVersion": {
  "type": "integer",
  "description": "The version of the vault contents"
}

Annotations

Description  Number of active items in the vault

Diagram

Type

number

Source


 "items": {
  "type": "integer",
  "description": "Number of active items in the vault"
}

Diagram

Type

string

Enumeration

Values

PERSONAL

TRANSFER

USER_CREATED

EVERYONE

Source


 "type": {
  "type": "string",
  "enum": [
    "PERSONAL",
    "TRANSFER",
    "USER_CREATED",
    "EVERYONE"
  ]
}

Diagram

Type

string

Constraints

Format : date-time

Source


 "createdAt": {
  "type": "string",
  "format": "date-time",
  "readOnly": true
}

Diagram

Type

string

Constraints

Format : date-time

Source


 "updatedAt": {
  "type": "string",
  "format": "date-time",
  "readOnly": true
}

Annotations

Description  The state of a registered server dependency.

Diagram

Type

object

Properties

Name	Occurrence
service status message	optional optional optional

Source


 "ServiceDependency": {
  "type": "object",
  "description": "The state of a registered server dependency.",
  "properties": {
    "service": {"type": "string"},
    "status": {"type": "string"},
    "message": {
      "type": "string",
      "description": "Human-readable message for explaining the current state."
    }
  }
}

Diagram

Type

string

Source


 "service": {"type": "string"}

Diagram

Type

string

Source


 "status": {"type": "string"}

Annotations

Description  Human-readable message for explaining the current state.

Diagram

Type

string

Source


 "message": {
  "type": "string",
  "description": "Human-readable message for explaining the current state."
}

Diagram

Type

object

Properties

Name	Occurrence
id name size content_path section content	optional optional optional optional optional optional

Source


 "File": {
  "type": "object",
  "example": {
    "id": "6r65pjq33banznomn7q22sj44e",
    "name": "foo.txt",
    "size": 35,
    "content_path": "v1/vaults/ionaiwtdvgclrixbt6ztpqcxnq/items/p7eflcy7f5mk7vg6zrzf5rjjyu/files/6r65pjq33banznomn7q22sj44e/content",
    "content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo="
  },
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the file"
    },
    "name": {
      "type": "string",
      "description": "Name of the file"
    },
    "size": {
      "type": "integer",
      "description": "Size in bytes of the file"
    },
    "content_path": {
      "type": "string",
      "description": "Path of the Connect API that can be used to download the contents of this file.",
      "readOnly": true
    },
    "section": {
      "type": "object",
      "description": "For files that are in a section, this field describes the section.",
      "properties": {}
    },
    "content": {
      "type": "string",
      "description": "Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and `inline_files` is set to `true`."
    }
  }
}

Annotations

Description  ID of the file

Diagram

Type

string

Source


 "id": {
  "type": "string",
  "description": "ID of the file"
}

Annotations

Description  Name of the file

Diagram

Type

string

Source


 "name": {
  "type": "string",
  "description": "Name of the file"
}

Annotations

Description  Size in bytes of the file

Diagram

Type

number

Source


 "size": {
  "type": "integer",
  "description": "Size in bytes of the file"
}

Annotations

Description  Path of the Connect API that can be used to download the contents of this file.

Diagram

Type

string

Source


 "content_path": {
  "type": "string",
  "description": "Path of the Connect API that can be used to download the contents of this file.",
  "readOnly": true
}

Annotations

Description  For files that are in a section, this field describes the section.

Diagram

Type

object

Properties

Name	Occurrence
id	optional

Source


 "section": {
  "type": "object",
  "description": "For files that are in a section, this field describes the section.",
  "properties": {
    "id": {"type": "string"}
  }
}

Diagram

Type

string

Source


 "id": {"type": "string"}

Annotations

Description  Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and `inline_files` is set to `true`.

Diagram

Type

string

Source


 "content": {
  "type": "string",
  "description": "Base64-encoded contents of the file. Only set if size <= OP_MAX_INLINE_FILE_SIZE_KB kb and `inline_files` is set to `true`."
}

Diagram

Type

array

Constraints

Unique Items : false

Array Items

Items

#/properties/Patch/items

Source


 "Patch": {
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "op",
      "path"
    ],
    "properties": {
      "op": {
        "type": "string",
        "enum": [
          "add",
          "replace",
          "remove"
        ]
      },
      "path": {
        "type": "string",
        "description": "An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute",
        "example": "/fields/06gnn2b95example10q91512p5/label"
      },
      "value": {"type": "object"}
    }
  }
}

Diagram

Type

object

Properties

Name	Occurrence
op path value	required required optional

Source


 "items": {
  "type": "object",
  "required": [
    "op",
    "path"
  ],
  "properties": {
    "op": {
      "type": "string",
      "enum": [
        "add",
        "replace",
        "remove"
      ]
    },
    "path": {
      "type": "string",
      "description": "An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute",
      "example": "/fields/06gnn2b95example10q91512p5/label"
    },
    "value": {"type": "object"}
  }
}

Diagram

Type

string

Enumeration

Values

add

replace

remove

Source


 "op": {
  "type": "string",
  "enum": [
    "add",
    "replace",
    "remove"
  ]
}

Annotations

Description  An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute

Diagram

Type

string

Source


 "path": {
  "type": "string",
  "description": "An RFC6901 JSON Pointer pointing to the Item document, an Item Attribute, and Item Field by Field ID, or an Item Field Attribute",
  "example": "/fields/06gnn2b95example10q91512p5/label"
}

Diagram

Type

object

Source


 "value": {"type": "object"}

Annotations

Description  The recipe is used in conjunction with the "generate" property to set the character set used to generate a new secure value

Diagram

Type

object

Properties

Name	Occurrence
length characterSets	optional optional

Source


 "GeneratorRecipe": {
  "type": "object",
  "description": "The recipe is used in conjunction with the \"generate\" property to set the character set used to generate a new secure value",
  "properties": {
    "length": {
      "type": "integer",
      "minimum": 1,
      "maximum": 64,
      "description": "Length of the generated value",
      "default": 32
    },
    "characterSets": {
      "type": "array",
      "uniqueItems": true,
      "minimum": 0,
      "maximum": 3,
      "items": {}
    }
  }
}

Annotations

Description  Length of the generated value

Diagram

Type

number

Constraints

Minimum : 1

Maximum : 64

Default : 32

Source


 "length": {
  "type": "integer",
  "minimum": 1,
  "maximum": 64,
  "description": "Length of the generated value",
  "default": 32
}

Diagram

Type

object

All of

Choices

characterSets : Schema (#/properties/GeneratorRecipe/properties/characterSets/0)

characterSets : Schema (#/properties/GeneratorRecipe/properties/characterSets/1)

Source


 "characterSets": {
  "type": "array",
  "uniqueItems": true,
  "items": {
    "type": "string",
    "enum": [
      "LETTERS",
      "DIGITS",
      "SYMBOLS"
    ]
  },
  "minimum": 0,
  "maximum": 3
}

Diagram

Type

array

Constraints

Unique Items : true

Array Items

Items

#/properties/GeneratorRecipe/properties/characterSets/items

Source


 "#/properties/GeneratorRecipe/properties/characterSets/0": {
  "type": "array",
  "uniqueItems": true,
  "items": {
    "type": "string",
    "enum": [
      "LETTERS",
      "DIGITS",
      "SYMBOLS"
    ]
  }
}

Diagram

Type

string

Enumeration

Values

LETTERS

DIGITS

SYMBOLS

Source


 "items": {
  "type": "string",
  "enum": [
    "LETTERS",
    "DIGITS",
    "SYMBOLS"
  ]
}

Diagram

Type

number

Constraints

Minimum : 0

Maximum : 3

Source


 "#/properties/GeneratorRecipe/properties/characterSets/1": {
  "minimum": 0,
  "maximum": 3
}