GitHub · JSON Structure

Github Teams Team Full Structure

Groups of organization members that gives permissions on specified repositories.

Type: object Properties: 18 Required: 15
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

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

Properties

id node_id url html_url name slug description privacy permission members_url repositories_url parent members_count repos_count created_at updated_at organization ldap_dn

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-teams-team-full-structure.json",
  "name": "team-full",
  "description": "Groups of organization members that gives permissions on specified repositories.",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier of the team",
      "example": 42,
      "type": "int32"
    },
    "node_id": {
      "type": "string",
      "example": "MDQ6VGVhbTE="
    },
    "url": {
      "description": "URL for the team",
      "example": "https://api.github.com/organizations/1/team/1",
      "type": "uri"
    },
    "html_url": {
      "type": "uri",
      "example": "https://github.com/orgs/rails/teams/core"
    },
    "name": {
      "description": "Name of the team",
      "example": "Developers",
      "type": "string"
    },
    "slug": {
      "type": "string",
      "example": "justice-league"
    },
    "description": {
      "type": "string",
      "example": "A great team.",
      "nullable": true
    },
    "privacy": {
      "description": "The level of privacy this team should have",
      "type": "string",
      "enum": [
        "closed",
        "secret"
      ],
      "example": "closed"
    },
    "permission": {
      "description": "Permission that the team will have for its repositories",
      "example": "push",
      "type": "string"
    },
    "members_url": {
      "type": "string",
      "example": "https://api.github.com/organizations/1/team/1/members{/member}"
    },
    "repositories_url": {
      "type": "uri",
      "example": "https://api.github.com/organizations/1/team/1/repos"
    },
    "parent": {
      "$ref": "#/components/schemas/nullable-team-simple"
    },
    "members_count": {
      "type": "int32",
      "example": 3
    },
    "repos_count": {
      "type": "int32",
      "example": 10
    },
    "created_at": {
      "type": "datetime",
      "example": "2017-07-14T16:53:42Z"
    },
    "updated_at": {
      "type": "datetime",
      "example": "2017-08-17T12:37:15Z"
    },
    "organization": {
      "$ref": "#/components/schemas/team-organization"
    },
    "ldap_dn": {
      "description": "Distinguished Name (DN) that team maps to within LDAP environment",
      "example": "uid=example,ou=users,dc=github,dc=com",
      "type": "string"
    }
  },
  "required": [
    "id",
    "node_id",
    "url",
    "members_url",
    "name",
    "description",
    "permission",
    "html_url",
    "repositories_url",
    "slug",
    "created_at",
    "updated_at",
    "members_count",
    "repos_count",
    "organization"
  ]
}