GitHub · Schema

organization-custom-repository-role

Custom repository roles created by organization owners

CodePipelinesPlatformSoftware DevelopmentSource ControlT1

Properties

Name	Type	Description
id	integer	The unique identifier of the custom role.
name	string	The name of the custom role.
description	string	A short description about who this role is for or what permissions it grants.
base_role	string	The system role from which this role inherits permissions.
permissions	array	A list of additional permissions included in this role.
organization	object
created_at	string
updated_at	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-organizations-organization-custom-repository-role-schema.json",
  "title": "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": "integer",
      "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": "string",
      "format": "date-time",
      "example": "2026-04-17T12:00:00Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2026-04-17T12:00:00Z"
    }
  },
  "required": [
    "id",
    "name",
    "base_role",
    "permissions",
    "organization",
    "created_at",
    "updated_at"
  ]
}