Collection Access Keys

APIs.ioEngineeringPlatform

Properties

Name Type Description
data array A list of collection access keys.
meta object The response's non-standard metadata information.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-getcollectionaccesskeys-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/getCollectionAccessKeys",
  "title": "Collection Access Keys",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "description": "A list of collection access keys.",
      "items": {
        "type": "object",
        "description": "Information about the collection access key.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The collection access key's ID.",
            "example": "Njg5OjU3MDQ1NjYtYmQxZDU3NzktMWVkNS00ZDhjLWI0ZmQtZWRhOGY2Mzg1NTY0"
          },
          "token": {
            "type": "string",
            "description": "The masked collection access key.",
            "example": "PMAT-**********************43BR"
          },
          "status": {
            "type": "string",
            "description": "The token's active status.",
            "enum": [
              "ACTIVE",
              "INACTIVE"
            ],
            "example": "ACTIVE"
          },
          "teamId": {
            "type": "integer",
            "description": "The team ID of the collection access key's owner.",
            "example": 123
          },
          "userId": {
            "type": "integer",
            "description": "The user ID of the collection access key's owner.",
            "example": 12345678
          },
          "collectionId": {
            "type": "string",
            "format": "uid",
            "description": "The collection access key's associated collection ID.",
            "example": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
          },
          "expiresAfter": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time at which the collection access key expires. Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date increases by another 60 days.",
            "example": "2024-06-11T13:21:11.000Z"
          },
          "lastUsedAt": {
            "type": "string",
            "description": "The date and time at which the collection access key was used. If the collection key is unused, this returns an empty string value.",
            "example": ""
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "example": "2024-04-12T13:21:11.000Z",
            "description": "The date and time at which the collection access key was created."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time at which the collection access key was updated.",
            "example": "2024-04-12T13:21:11.000Z"
          },
          "deletedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "The date and time at which the collection access key was revoked.",
            "example": "2024-04-12T13:21:11.000Z"
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "description": "The response's non-standard metadata information.",
      "properties": {
        "nextCursor": {
          "type": "string",
          "description": "The pagination cursor that points to the next record in the results set.",
          "example": "b2Zmc2V0PTEwJmxpbWl0PTEw"
        },
        "prevCursor": {
          "type": "string",
          "description": "The pagination cursor to previous set of response data.",
          "example": ""
        }
      }
    }
  }
}