GitHub · JSON Structure

Github Organizations Organization Full Structure

Organization Full

Type: object Properties: 56 Required: 23
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

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

Properties

login id node_id url repos_url events_url hooks_url issues_url members_url public_members_url avatar_url description name company blog location email twitter_username is_verified has_organization_projects has_repository_projects public_repos public_gists followers following html_url type total_private_repos owned_private_repos private_gists disk_usage collaborators billing_email plan default_repository_permission members_can_create_repositories two_factor_requirement_enabled members_allowed_repository_creation_type members_can_create_public_repositories members_can_create_private_repositories members_can_create_internal_repositories members_can_create_pages members_can_create_public_pages members_can_create_private_pages members_can_fork_private_repositories web_commit_signoff_required advanced_security_enabled_for_new_repositories dependabot_alerts_enabled_for_new_repositories dependabot_security_updates_enabled_for_new_repositories dependency_graph_enabled_for_new_repositories

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-full-structure.json",
  "name": "organization-full",
  "description": "Organization Full",
  "type": "object",
  "properties": {
    "login": {
      "type": "string",
      "example": "github"
    },
    "id": {
      "type": "int32",
      "example": 1
    },
    "node_id": {
      "type": "string",
      "example": "MDEyOk9yZ2FuaXphdGlvbjE="
    },
    "url": {
      "type": "uri",
      "example": "https://api.github.com/orgs/github"
    },
    "repos_url": {
      "type": "uri",
      "example": "https://api.github.com/orgs/github/repos"
    },
    "events_url": {
      "type": "uri",
      "example": "https://api.github.com/orgs/github/events"
    },
    "hooks_url": {
      "type": "string",
      "example": "https://api.github.com/orgs/github/hooks"
    },
    "issues_url": {
      "type": "string",
      "example": "https://api.github.com/orgs/github/issues"
    },
    "members_url": {
      "type": "string",
      "example": "https://api.github.com/orgs/github/members{/member}"
    },
    "public_members_url": {
      "type": "string",
      "example": "https://api.github.com/orgs/github/public_members{/member}"
    },
    "avatar_url": {
      "type": "string",
      "example": "https://github.com/images/error/octocat_happy.gif"
    },
    "description": {
      "type": "string",
      "example": "A great organization",
      "nullable": true
    },
    "name": {
      "type": "string",
      "example": "github"
    },
    "company": {
      "type": "string",
      "example": "GitHub"
    },
    "blog": {
      "type": "uri",
      "example": "https://github.com/blog"
    },
    "location": {
      "type": "string",
      "example": "San Francisco"
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "octocat@github.com"
    },
    "twitter_username": {
      "type": "string",
      "example": "github",
      "nullable": true
    },
    "is_verified": {
      "type": "boolean",
      "example": true
    },
    "has_organization_projects": {
      "type": "boolean",
      "example": true
    },
    "has_repository_projects": {
      "type": "boolean",
      "example": true
    },
    "public_repos": {
      "type": "int32",
      "example": 2
    },
    "public_gists": {
      "type": "int32",
      "example": 1
    },
    "followers": {
      "type": "int32",
      "example": 20
    },
    "following": {
      "type": "int32",
      "example": 0
    },
    "html_url": {
      "type": "uri",
      "example": "https://github.com/octocat"
    },
    "type": {
      "type": "string",
      "example": "Organization"
    },
    "total_private_repos": {
      "type": "int32",
      "example": 100
    },
    "owned_private_repos": {
      "type": "int32",
      "example": 100
    },
    "private_gists": {
      "type": "int32",
      "example": 81,
      "nullable": true
    },
    "disk_usage": {
      "type": "int32",
      "example": 10000,
      "nullable": true
    },
    "collaborators": {
      "type": "int32",
      "example": 8,
      "nullable": true
    },
    "billing_email": {
      "type": "string",
      "format": "email",
      "example": "org@example.com",
      "nullable": true
    },
    "plan": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "space": {
          "type": "int32"
        },
        "private_repos": {
          "type": "int32"
        },
        "filled_seats": {
          "type": "int32"
        },
        "seats": {
          "type": "int32"
        }
      },
      "required": [
        "name",
        "space",
        "private_repos"
      ]
    },
    "default_repository_permission": {
      "type": "string",
      "nullable": true
    },
    "members_can_create_repositories": {
      "type": "boolean",
      "example": true,
      "nullable": true
    },
    "two_factor_requirement_enabled": {
      "type": "boolean",
      "example": true,
      "nullable": true
    },
    "members_allowed_repository_creation_type": {
      "type": "string",
      "example": "all"
    },
    "members_can_create_public_repositories": {
      "type": "boolean",
      "example": true
    },
    "members_can_create_private_repositories": {
      "type": "boolean",
      "example": true
    },
    "members_can_create_internal_repositories": {
      "type": "boolean",
      "example": true
    },
    "members_can_create_pages": {
      "type": "boolean",
      "example": true
    },
    "members_can_create_public_pages": {
      "type": "boolean",
      "example": true
    },
    "members_can_create_private_pages": {
      "type": "boolean",
      "example": true
    },
    "members_can_fork_private_repositories": {
      "type": "boolean",
      "example": false,
      "nullable": true
    },
    "web_commit_signoff_required": {
      "type": "boolean",
      "example": false
    },
    "advanced_security_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
    },
    "dependabot_alerts_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to\nthis organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
    },
    "dependabot_security_updates_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether dependabot security updates are automatically enabled for new repositories and repositories transferred\nto this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
    },
    "dependency_graph_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether dependency graph is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
    },
    "secret_scanning_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether secret scanning is automatically enabled for new repositories and repositories transferred to this\norganization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
    },
    "secret_scanning_push_protection_enabled_for_new_repositories": {
      "type": "boolean",
      "example": false,
      "description": "Whether secret scanning push protection is automatically enabled for new repositories and repositories\ntransferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role."
    },
    "secret_scanning_push_protection_custom_link_enabled": {
      "type": "boolean",
      "example": false,
      "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection."
    },
    "secret_scanning_push_protection_custom_link": {
      "type": "string",
      "example": "https://github.com/test-org/test-repo/blob/main/README.md",
      "nullable": true,
      "description": "An optional URL string to display to contributors who are blocked from pushing a secret."
    },
    "created_at": {
      "type": "datetime",
      "example": "2008-01-14T04:33:35Z"
    },
    "updated_at": {
      "type": "datetime"
    }
  },
  "required": [
    "login",
    "url",
    "id",
    "node_id",
    "repos_url",
    "events_url",
    "hooks_url",
    "issues_url",
    "members_url",
    "public_members_url",
    "avatar_url",
    "description",
    "html_url",
    "has_organization_projects",
    "has_repository_projects",
    "public_repos",
    "public_gists",
    "followers",
    "following",
    "type",
    "created_at",
    "updated_at",
    "archived_at"
  ]
}