Authentication Token

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
token	string	The token used for authentication
expires_at	string	The time this token expires
permissions	object
repositories	array	The repositories this token has access to
single_file	string
repository_selection	string	Describe whether all repositories have been selected or there's a selection involved

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/authentication-token",
  "title": "Authentication Token",
  "description": "Authentication Token",
  "type": "object",
  "properties": {
    "token": {
      "description": "The token used for authentication",
      "type": "string",
      "example": "v1.1f699f1069f60xxx"
    },
    "expires_at": {
      "description": "The time this token expires",
      "type": "string",
      "format": "date-time",
      "example": "2016-07-11T22:14:10Z"
    },
    "permissions": {
      "type": "object",
      "example": {
        "issues": "read",
        "deployments": "write"
      }
    },
    "repositories": {
      "description": "The repositories this token has access to",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/repository"
      }
    },
    "single_file": {
      "type": "string",
      "example": "config.yaml",
      "nullable": true
    },
    "repository_selection": {
      "description": "Describe whether all repositories have been selected or there's a selection involved",
      "type": "string",
      "enum": [
        "all",
        "selected"
      ]
    }
  },
  "required": [
    "token",
    "expires_at"
  ]
}