Documentation for schema

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

Used by

Schema

APIRequest

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

Used by

Schema

APIRequest

APIRequest/properties/requestId

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

Used by

Schema

APIRequest

APIRequest/properties/timestamp

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

Used by

Schema

APIRequest

APIRequest/properties/action

Source


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

Diagram

Type

string

Enumeration

Values

SUCCESS

DENY

Used by

Schema

APIRequest

APIRequest/properties/result

Source


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

Diagram

Type

object

Properties

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

Used by

Schema

APIRequest

APIRequest/properties/actor

Source


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

Diagram

Type

string

Used by

Schema

APIRequest/properties/actor

APIRequest/properties/actor/properties/id

Source


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

Diagram

Type

string

Used by

Schema

APIRequest/properties/actor

APIRequest/properties/actor/properties/account

Source


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

Diagram

Type

string

Used by

Schema

APIRequest/properties/actor

APIRequest/properties/actor/properties/jti

Source


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

Diagram

Type

string

Used by

Schema

APIRequest/properties/actor

APIRequest/properties/actor/properties/userAgent

Source


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

Diagram

Type

string

Used by

Schema

APIRequest/properties/actor

APIRequest/properties/actor/properties/requestIp

Source


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

Diagram

Type

object

Properties

Name	Occurrence
type vault item itemVersion	optional optional optional optional

Used by

Schema

APIRequest

APIRequest/properties/resource

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

Used by

Schema

APIRequest/properties/resource

APIRequest/properties/resource/properties/type

Source


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

Diagram

Type

object

Properties

Name	Occurrence
id	optional

Used by

Schema

APIRequest/properties/resource

APIRequest/properties/resource/properties/vault

Source


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

Diagram

Type

string

Constraints

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

Used by

Schema

APIRequest/properties/resource/properties/vault

APIRequest/properties/resource/properties/vault/properties/id

Source


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

Diagram

Type

object

Properties

Name	Occurrence
id	optional

Used by

Schema

APIRequest/properties/resource

APIRequest/properties/resource/properties/item

Source


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

Diagram

Type

string

Constraints

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

Used by

Schema

APIRequest/properties/resource/properties/item

APIRequest/properties/resource/properties/item/properties/id

Source


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

Diagram

Type

number

Used by

Schema

APIRequest/properties/resource

APIRequest/properties/resource/properties/itemVersion

Source


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