GitHub · JSON Structure

Github Organizations Organization Custom Repository Role Structure

Custom repository roles created by organization owners

Type: object Properties: 8 Required: 7
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

organization-custom-repository-role is a JSON Structure definition published by GitHub, describing 8 properties, of which 7 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description base_role permissions organization created_at updated_at

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-organizations-organization-custom-repository-role-structure.json",
  "name": "organization-custom-repository-role",
  "description": "Custom repository roles created by organization owners",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier of the custom role.",
      "type": "int32",
      "example": 42
    },
    "name": {
      "description": "The name of the custom role.",
      "type": "string",
      "example": "octocat"
    },
    "description": {
      "description": "A short description about who this role is for or what permissions it grants.",
      "type": "string",
      "nullable": true,
      "example": "This is an example repository"
    },
    "base_role": {
      "type": "string",
      "description": "The system role from which this role inherits permissions.",
      "enum": [
        "read",
        "triage",
        "write",
        "maintain"
      ],
      "example": "read"
    },
    "permissions": {
      "description": "A list of additional permissions included in this role.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "organization": {
      "$ref": "#/components/schemas/simple-user"
    },
    "created_at": {
      "type": "datetime",
      "example": "2026-04-17T12:00:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "example": "2026-04-17T12:00:00Z"
    }
  },
  "required": [
    "id",
    "name",
    "base_role",
    "permissions",
    "organization",
    "created_at",
    "updated_at"
  ]
}