Authorization

The authorization for an OAuth app, GitHub App, or a Personal Access Token.

APIs.ioEngineeringPlatform

Properties

Name Type Description
id integer
url string
scopes array A list of scopes that this authorization is in.
token string
token_last_eight string
hashed_token string
app object
note string
note_url string
updated_at string
created_at string
fingerprint string
user object
installation object
expires_at string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-authorization-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/authorization",
  "title": "Authorization",
  "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "scopes": {
      "description": "A list of scopes that this authorization is in.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "token": {
      "type": "string"
    },
    "token_last_eight": {
      "type": "string",
      "nullable": true
    },
    "hashed_token": {
      "type": "string",
      "nullable": true
    },
    "app": {
      "type": "object",
      "properties": {
        "client_id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "client_id",
        "name",
        "url"
      ]
    },
    "note": {
      "type": "string",
      "nullable": true
    },
    "note_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "fingerprint": {
      "type": "string",
      "nullable": true
    },
    "user": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "installation": {
      "$ref": "#/components/schemas/nullable-scoped-installation"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    }
  },
  "required": [
    "app",
    "id",
    "note",
    "note_url",
    "scopes",
    "token",
    "hashed_token",
    "token_last_eight",
    "fingerprint",
    "url",
    "created_at",
    "updated_at",
    "expires_at"
  ]
}