List Api Keys

v1.0.0

List Api Keys

Input

{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string"
    },
    "filter": {
      "type": "object"
    },
    "filter_gt": {
      "type": "object"
    },
    "filter_gteq": {
      "type": "object"
    },
    "filter_like": {
      "type": "object"
    },
    "filter_lt": {
      "type": "object"
    },
    "filter_lteq": {
      "type": "object"
    },
    "per_page": {
      "type": "integer",
      "format": "int32"
    },
    "sort_by": {
      "type": "object"
    },
    "user_id": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "description": "List Api Keys",
    "properties": {
      "created_at": {
        "type": "string",
        "format": "date-time",
        "description": "Time which API Key was created"
      },
      "description": {
        "type": "string",
        "description": "User-supplied description of API key."
      },
      "descriptive_label": {
        "type": "string",
        "description": "Unique label that describes this API key.  Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key."
      },
      "expires_at": {
        "type": "string",
        "format": "date-time",
        "description": "API Key expiration date"
      },
      "id": {
        "type": "integer",
        "format": "int32",
        "description": "API Key ID"
      },
      "key": {
        "type": "string",
        "description": "API Key actual key string"
      },
      "last_use_at": {
        "type": "string",
        "format": "date-time",
        "description": "API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp."
      },
      "name": {
        "type": "string",
        "description": "Internal name for the API Key.  For your use."
      },
      "path": {
        "type": "string",
        "description": "Folder path restriction for this api key."
      },
      "permission_set": {
        "type": "string",
        "description": "Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.",
        "enum": [
          "none",
          "full",
          "desktop_app",
          "sync_app",
          "office_integration",
          "mobile_app"
        ]
      },
      "platform": {
        "type": "string",
        "description": "If this API key represents a Desktop app, what platform was it created on?"
      },
      "url": {
        "type": "string",
        "description": "URL for API host."
      },
      "user_id": {
        "type": "integer",
        "format": "int32",
        "description": "User ID for the owner of this API Key.  May be blank for Site-wide API Keys."
      }
    }
  }
}