GitHub · JSON Structure

Github App Api Authorization Structure

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

Type: object Properties: 15 Required: 13

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

authorization is a JSON Structure definition published by GitHub, describing 15 properties, of which 13 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id url scopes token token_last_eight hashed_token app note note_url updated_at created_at fingerprint user installation expires_at

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-app-api-authorization-structure.json",
  "name": "authorization",
  "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "example": 42
    },
    "url": {
      "type": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "scopes": {
      "description": "A list of scopes that this authorization is in.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true
    },
    "token": {
      "type": "string",
      "example": "example_value"
    },
    "token_last_eight": {
      "type": "string",
      "nullable": true,
      "example": "example_value"
    },
    "hashed_token": {
      "type": "string",
      "nullable": true,
      "example": "example_value"
    },
    "app": {
      "type": "object",
      "properties": {
        "client_id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "url": {
          "type": "uri"
        }
      },
      "required": [
        "client_id",
        "name",
        "url"
      ]
    },
    "note": {
      "type": "string",
      "nullable": true,
      "example": "example_value"
    },
    "note_url": {
      "type": "uri",
      "nullable": true,
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "updated_at": {
      "type": "datetime",
      "example": "2026-04-17T12:00:00Z"
    },
    "created_at": {
      "type": "datetime",
      "example": "2026-04-17T12:00:00Z"
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "example": "example_value"
    },
    "user": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "installation": {
      "$ref": "#/components/schemas/nullable-scoped-installation"
    },
    "expires_at": {
      "type": "datetime",
      "nullable": true,
      "example": "2026-04-17T12:00:00Z"
    }
  },
  "required": [
    "app",
    "id",
    "note",
    "note_url",
    "scopes",
    "token",
    "hashed_token",
    "token_last_eight",
    "fingerprint",
    "url",
    "created_at",
    "updated_at",
    "expires_at"
  ]
}