GitHub: Orgs schemas

← Orgs operations · All schemas

Create an organization invitation — response body

Field	Type	Presence	Description and constraints
$	object	Root	Organization Invitation
created_at	string	Required within parent
email	JSON	Required within parent
email (anyOf 1)	string	Alternative
email (anyOf 2)	null	Alternative
failed_at	JSON	Optional
failed_at (anyOf 1)	string	Alternative
failed_at (anyOf 2)	null	Alternative
failed_reason	JSON	Optional
failed_reason (anyOf 1)	string	Alternative
failed_reason (anyOf 2)	null	Alternative
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
invitation_source	string	Optional
invitation_teams_url	string	Required within parent
inviter	Model	Required within parent	Expand List users — response body — item
login	JSON	Required within parent
login (anyOf 1)	string	Alternative
login (anyOf 2)	null	Alternative
node_id	string	Required within parent
role	string	Required within parent
team_count	JSON	Required within parent
team_count (anyOf 1)	integer	Alternative
team_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List users — response body — item

Create issue field for an organization — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
data_type	string	Required within parent	The data type of the issue field. One of: text, date, single_select, multi_select, number
description	JSON	Optional
description (anyOf 1)	string	Alternative	Description of the issue field.
description (anyOf 2)	null	Alternative
name	string	Required within parent	Name of the issue field.
options	JSON	Optional
options (anyOf 1)	array	Alternative	Options for select fields. Required when data_type is 'single_select' or 'multi_select'.
options (anyOf 1)[]	object	Each item
options (anyOf 1)[].color	string	Required within parent	Color for the option. One of: gray, blue, green, yellow, orange, red, pink, purple
options (anyOf 1)[].description	JSON	Optional
options (anyOf 1)[].description (anyOf 1)	string	Alternative	Description of the option.
options (anyOf 1)[].description (anyOf 2)	null	Alternative
options (anyOf 1)[].name	string	Required within parent	Name of the option.
options (anyOf 1)[].priority	integer	Required within parent	Priority of the option for ordering.
options (anyOf 2)	null	Alternative
visibility	string	Optional	The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to `organization_members_only`. One of: organization_members_only, all

Create issue field for an organization — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	A custom attribute defined at the organization level for attaching structured data to issues.
$ (anyOf 1).created_at	string	Optional	The time the issue field was created. Format: date-time
$ (anyOf 1).data_type	string	Required within parent	The data type of the issue field. Known values: text, date, single_select, multi_select, number
$ (anyOf 1).description	JSON	Optional
$ (anyOf 1).description (anyOf 1)	string	Alternative	The description of the issue field.
$ (anyOf 1).description (anyOf 2)	null	Alternative
$ (anyOf 1).id	JSON	Required within parent
$ (anyOf 1).id (anyOf 1)	integer	Alternative	The unique identifier of the issue field.
$ (anyOf 1).id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).name	string	Required within parent	The name of the issue field.
$ (anyOf 1).node_id	string	Required within parent	The node identifier of the issue field.
$ (anyOf 1).options	JSON	Optional
$ (anyOf 1).options (anyOf 1)	array	Alternative	Available options for single select and multi select fields.
$ (anyOf 1).options (anyOf 1)[]	object	Each item
$ (anyOf 1).options (anyOf 1)[].color	JSON	Optional
$ (anyOf 1).options (anyOf 1)[].color (anyOf 1)	string	Alternative	The color of the option. Known values: gray, blue, green, yellow, orange, red, pink, purple
$ (anyOf 1).options (anyOf 1)[].color (anyOf 2)	null	Alternative
$ (anyOf 1).options (anyOf 1)[].created_at	string	Optional	The time the option was created. Format: date-time
$ (anyOf 1).options (anyOf 1)[].description	JSON	Optional
$ (anyOf 1).options (anyOf 1)[].description (anyOf 1)	string	Alternative	The description of the option.
$ (anyOf 1).options (anyOf 1)[].description (anyOf 2)	null	Alternative
$ (anyOf 1).options (anyOf 1)[].id	JSON	Required within parent
$ (anyOf 1).options (anyOf 1)[].id (anyOf 1)	integer	Alternative	The unique identifier of the option.
$ (anyOf 1).options (anyOf 1)[].id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).options (anyOf 1)[].name	string	Required within parent	The name of the option.
$ (anyOf 1).options (anyOf 1)[].priority	JSON	Optional
$ (anyOf 1).options (anyOf 1)[].priority (anyOf 1)	JSON	Alternative
$ (anyOf 1).options (anyOf 1)[].priority (anyOf 1) (anyOf 1)	integer	Alternative	The priority of the option for ordering.
$ (anyOf 1).options (anyOf 1)[].priority (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).options (anyOf 1)[].priority (anyOf 2)	null	Alternative
$ (anyOf 1).options (anyOf 1)[].updated_at	string	Optional	The time the option was last updated. Format: date-time
$ (anyOf 1).options (anyOf 2)	null	Alternative
$ (anyOf 1).updated_at	string	Optional	The time the issue field was last updated. Format: date-time
$ (anyOf 1).visibility	string	Optional	The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Known values: organization_members_only, all
$ (anyOf 2)	null	Alternative

Create issue type for an organization — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
color	JSON	Optional
color (anyOf 1)	string	Alternative	Color for the issue type. One of: gray, blue, green, yellow, orange, red, pink, purple
color (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	Description of the issue type.
description (anyOf 2)	null	Alternative
is_enabled	boolean	Required within parent	Whether or not the issue type is enabled at the organization level.
name	string	Required within parent	Name of the issue type.

Create issue type for an organization — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The type assigned to the issue. This is only present for issues in repositories where issue types are supported.
$ (anyOf 1).color	JSON	Optional
$ (anyOf 1).color (anyOf 1)	string	Alternative	The color of the issue type. Known values: gray, blue, green, yellow, orange, red, pink, purple
$ (anyOf 1).color (anyOf 2)	null	Alternative
$ (anyOf 1).created_at	string	Optional	The time the issue type created. Format: date-time
$ (anyOf 1).description	JSON	Required within parent
$ (anyOf 1).description (anyOf 1)	string	Alternative	The description of the issue type.
$ (anyOf 1).description (anyOf 2)	null	Alternative
$ (anyOf 1).id	JSON	Required within parent
$ (anyOf 1).id (anyOf 1)	integer	Alternative	The unique identifier of the issue type.
$ (anyOf 1).id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).is_enabled	boolean	Optional	The enabled state of the issue type.
$ (anyOf 1).name	string	Required within parent	The name of the issue type.
$ (anyOf 1).node_id	string	Required within parent	The node identifier of the issue type.
$ (anyOf 1).updated_at	string	Optional	The time the issue type last updated. Format: date-time
$ (anyOf 2)	null	Alternative

Create or update a custom property for an organization — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Custom property set payload
allowed_values	JSON	Optional
allowed_values (anyOf 1)	array	Alternative	An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
allowed_values (anyOf 1)[]	string	Each item
allowed_values (anyOf 2)	null	Alternative
default_value	JSON	Optional
default_value (anyOf 1)	JSON	Alternative	Default value of the property
default_value (anyOf 1) (oneOf 1)	JSON	Alternative
default_value (anyOf 1) (oneOf 1) (anyOf 1)	string	Alternative
default_value (anyOf 1) (oneOf 1) (anyOf 2)	null	Alternative
default_value (anyOf 1) (oneOf 2)	array	Alternative
default_value (anyOf 1) (oneOf 2)[]	string	Each item
default_value (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	Short description of the property
description (anyOf 2)	null	Alternative
require_explicit_values	boolean	Optional	Whether setting properties values is mandatory
required	boolean	Optional	Whether the property is required.
value_type	string	Required within parent	The type of the value for the property One of: string, single_select, multi_select, true_false, url
values_editable_by	JSON	Optional
values_editable_by (anyOf 1)	string	Alternative	Who can edit the values of the property One of: org_actors, org_and_repo_actors
values_editable_by (anyOf 2)	null	Alternative

Create or update custom properties for an organization — request body — body properties item

Field	Type	Presence	Description and constraints
$	object	Root	Custom property defined on an organization
allowed_values	JSON	Optional
allowed_values (anyOf 1)	array	Alternative	An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
allowed_values (anyOf 1)[]	string	Each item
allowed_values (anyOf 2)	null	Alternative
default_value	JSON	Optional
default_value (anyOf 1)	JSON	Alternative	Default value of the property
default_value (anyOf 1) (oneOf 1)	string	Alternative
default_value (anyOf 1) (oneOf 2)	array	Alternative
default_value (anyOf 1) (oneOf 2)[]	string	Each item
default_value (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	Short description of the property
description (anyOf 2)	null	Alternative
property_name	string	Required within parent	The name of the property
require_explicit_values	boolean	Optional	Whether setting properties values is mandatory
required	boolean	Optional	Whether the property is required.
source_type	string	Optional	The source type of the property One of: organization, enterprise
url	string	Optional	The URL that can be used to fetch, update, or delete info about this property via the API. Format: uri
value_type	string	Required within parent	The type of the value for the property One of: string, single_select, multi_select, true_false, url
values_editable_by	JSON	Optional
values_editable_by (anyOf 1)	string	Alternative	Who can edit the values of the property One of: org_actors, org_and_repo_actors
values_editable_by (anyOf 2)	null	Alternative

Create or update external custom property values for a property across organization repositories — request body — body repository values item

Field	Type	Presence	Description and constraints
$	object	Root	Repository name and associated external custom property value
repository_name	string	Required within parent	The name of the repository
value	JSON	Required within parent
value (anyOf 1)	string	Alternative	The value assigned to the repository. Set to `null` to unset the value for this repository.
value (anyOf 2)	null	Alternative

Get a custom property for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	Custom property defined on an organization
allowed_values	JSON	Optional
allowed_values (anyOf 1)	array	Alternative	An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
allowed_values (anyOf 1)[]	string	Each item
allowed_values (anyOf 2)	null	Alternative
default_value	JSON	Optional
default_value (anyOf 1)	JSON	Alternative	Default value of the property
default_value (anyOf 1) (anyOf 1)	string	Alternative
default_value (anyOf 1) (anyOf 2)	array	Alternative
default_value (anyOf 1) (anyOf 2)[]	string	Each item
default_value (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	Short description of the property
description (anyOf 2)	null	Alternative
property_name	string	Required within parent	The name of the property
require_explicit_values	boolean	Optional	Whether setting properties values is mandatory
required	boolean	Optional	Whether the property is required.
source_type	string	Optional	The source type of the property Known values: organization, enterprise
url	string	Optional	The URL that can be used to fetch, update, or delete info about this property via the API. Format: uri
value_type	string	Required within parent	The type of the value for the property Known values: string, single_select, multi_select, true_false, url
values_editable_by	JSON	Optional
values_editable_by (anyOf 1)	string	Alternative	Who can edit the values of the property Known values: org_actors, org_and_repo_actors
values_editable_by (anyOf 2)	null	Alternative

Get all external custom properties for a Git Hub App installation in an organization — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	External custom property defined for a GitHub App installation
property_name	string	Required within parent	The name of the external property

Get an organization role — response body

Field	Type	Presence	Description and constraints
$	object	Root	Organization roles
base_role	JSON	Optional
base_role (anyOf 1)	string	Alternative	The system role from which this role inherits permissions. Known values: read, triage, write, maintain, admin
base_role (anyOf 2)	null	Alternative
created_at	string	Required within parent	The date and time the role was created. Format: date-time
description	JSON	Optional
description (anyOf 1)	string	Alternative	A short description about who this role is for or what permissions it grants.
description (anyOf 2)	null	Alternative
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The unique identifier of the role. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the role.
organization	Model	Required within parent	Expand Get an issue — response body — user
permissions	array	Required within parent	A list of permissions included in this role.
permissions[]	string	Each item
source	JSON	Optional
source (anyOf 1)	string	Alternative	Source answers the question, "where did this role come from?" Known values: Organization, Enterprise, Predefined
source (anyOf 2)	null	Alternative
updated_at	string	Required within parent	The date and time the role was last updated. Format: date-time

Referenced models: Get an issue — response body — user

Get an organization webhook — response body

Field	Type	Presence	Description and constraints
$	object	Root	Org Hook
active	boolean	Required within parent
config	object	Required within parent
config.content_type	string	Optional
config.insecure_ssl	string	Optional
config.secret	string	Optional
config.url	string	Optional
created_at	string	Required within parent	Format: date-time
deliveries_url	string	Optional	Format: uri
events	array	Required within parent
events[]	string	Each item
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent
ping_url	string	Required within parent	Format: uri
type	string	Required within parent
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent	Format: uri

Get an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	Organization Full
advanced_security_enabled_for_new_repositories	boolean	Optional	**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
archived_at	JSON	Required within parent
archived_at (anyOf 1)	string	Alternative	Format: date-time
archived_at (anyOf 2)	null	Alternative
avatar_url	string	Required within parent
billing_email	JSON	Optional
billing_email (anyOf 1)	string	Alternative	Format: email
billing_email (anyOf 2)	null	Alternative
blog	JSON	Optional
blog (anyOf 1)	string	Alternative	Format: uri
blog (anyOf 2)	null	Alternative
collaborators	JSON	Optional
collaborators (anyOf 1)	JSON	Alternative
collaborators (anyOf 1) (anyOf 1)	integer	Alternative	The number of collaborators on private repositories. This field may be null if the number of private repositories is over 50,000.
collaborators (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
collaborators (anyOf 2)	null	Alternative
company	JSON	Optional
company (anyOf 1)	string	Alternative
company (anyOf 2)	null	Alternative
created_at	string	Required within parent	Format: date-time
default_repository_branch	JSON	Optional
default_repository_branch (anyOf 1)	string	Alternative	The default branch for repositories created in this organization.
default_repository_branch (anyOf 2)	null	Alternative
default_repository_permission	JSON	Optional
default_repository_permission (anyOf 1)	string	Alternative
default_repository_permission (anyOf 2)	null	Alternative
dependabot_alerts_enabled_for_new_repositories	boolean	Optional	**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
dependabot_security_updates_enabled_for_new_repositories	boolean	Optional	**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
dependency_graph_enabled_for_new_repositories	boolean	Optional	**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
deploy_keys_enabled_for_repositories	boolean	Optional	Controls whether or not deploy keys may be added and used for repositories in the organization.
description	JSON	Required within parent
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
disk_usage	JSON	Optional
disk_usage (anyOf 1)	JSON	Alternative
disk_usage (anyOf 1) (anyOf 1)	integer	Alternative
disk_usage (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
disk_usage (anyOf 2)	null	Alternative
display_commenter_full_name_setting_enabled	boolean	Optional
email	JSON	Optional
email (anyOf 1)	string	Alternative	Format: email
email (anyOf 2)	null	Alternative
events_url	string	Required within parent	Format: uri
followers	JSON	Required within parent
followers (anyOf 1)	integer	Alternative
followers (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
following	JSON	Required within parent
following (anyOf 1)	integer	Alternative
following (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
has_organization_projects	boolean	Required within parent
has_repository_projects	boolean	Required within parent
hooks_url	string	Required within parent
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_verified	boolean	Optional
issues_url	string	Required within parent
location	JSON	Optional
location (anyOf 1)	string	Alternative
location (anyOf 2)	null	Alternative
login	string	Required within parent
members_allowed_repository_creation_type	string	Optional
members_can_change_repo_visibility	boolean	Optional
members_can_create_internal_repositories	boolean	Optional
members_can_create_pages	boolean	Optional
members_can_create_private_pages	boolean	Optional
members_can_create_private_repositories	boolean	Optional
members_can_create_public_pages	boolean	Optional
members_can_create_public_repositories	boolean	Optional
members_can_create_repositories	JSON	Optional
members_can_create_repositories (anyOf 1)	boolean	Alternative
members_can_create_repositories (anyOf 2)	null	Alternative
members_can_create_teams	boolean	Optional
members_can_delete_issues	boolean	Optional
members_can_delete_repositories	boolean	Optional
members_can_fork_private_repositories	JSON	Optional
members_can_fork_private_repositories (anyOf 1)	boolean	Alternative
members_can_fork_private_repositories (anyOf 2)	null	Alternative
members_can_invite_outside_collaborators	boolean	Optional
members_can_view_dependency_insights	boolean	Optional
members_url	string	Required within parent
name	string	Optional
node_id	string	Required within parent
owned_private_repos	JSON	Optional
owned_private_repos (anyOf 1)	integer	Alternative
owned_private_repos (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
plan	Model	Optional	Expand Get an organization — response body — plan
private_gists	JSON	Optional
private_gists (anyOf 1)	JSON	Alternative
private_gists (anyOf 1) (anyOf 1)	integer	Alternative
private_gists (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
private_gists (anyOf 2)	null	Alternative
public_gists	JSON	Required within parent
public_gists (anyOf 1)	integer	Alternative
public_gists (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
public_members_url	string	Required within parent
public_repos	JSON	Required within parent
public_repos (anyOf 1)	integer	Alternative
public_repos (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
readers_can_create_discussions	boolean	Optional
repos_url	string	Required within parent	Format: uri
secret_scanning_enabled_for_new_repositories	boolean	Optional	**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
secret_scanning_push_protection_custom_link	JSON	Optional
secret_scanning_push_protection_custom_link (anyOf 1)	string	Alternative	An optional URL string to display to contributors who are blocked from pushing a secret.
secret_scanning_push_protection_custom_link (anyOf 2)	null	Alternative
secret_scanning_push_protection_enabled_for_new_repositories	boolean	Optional	**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
total_private_repos	JSON	Optional
total_private_repos (anyOf 1)	integer	Alternative
total_private_repos (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
twitter_username	JSON	Optional
twitter_username (anyOf 1)	string	Alternative
twitter_username (anyOf 2)	null	Alternative
two_factor_requirement_enabled	JSON	Optional
two_factor_requirement_enabled (anyOf 1)	boolean	Alternative
two_factor_requirement_enabled (anyOf 2)	null	Alternative
type	string	Required within parent
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent	Format: uri
web_commit_signoff_required	boolean	Optional

Referenced models: Get an organization — response body — plan

Get an organization — response body — plan

Field	Type	Presence	Description and constraints
$	object	Root
filled_seats	JSON	Optional
filled_seats (anyOf 1)	integer	Alternative
filled_seats (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent
private_repos	JSON	Required within parent
private_repos (anyOf 1)	integer	Alternative
private_repos (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
seats	JSON	Optional
seats (anyOf 1)	integer	Alternative
seats (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
space	JSON	Required within parent
space (anyOf 1)	integer	Alternative
space (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get immutable releases settings for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	Check immutable releases settings for an organization.
enforced_repositories	string	Required within parent	The policy that controls how immutable releases are enforced in the organization. Known values: all, none, selected
selected_repositories_url	string	Optional	The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`.

Get organization membership for a user — response body

Field	Type	Presence	Description and constraints
$	object	Root	Org Membership
direct_membership	boolean	Optional	Whether the user has direct membership in the organization.
enterprise_teams_providing_indirect_membership	array	Optional	The slugs of the enterprise teams providing the user with indirect membership in the organization. A limit of 100 enterprise team slugs is returned. Maximum items: 100
enterprise_teams_providing_indirect_membership[]	string	Each item
organization	Model	Required within parent	Expand List organizations — response body — item
organization_url	string	Required within parent	Format: uri
permissions	object	Optional
permissions.can_create_repository	boolean	Required within parent
role	string	Required within parent	The user's membership type in the organization. Known values: admin, member, billing_manager
state	string	Required within parent	The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. Known values: active, pending
url	string	Required within parent	Format: uri
user	Model	Required within parent	Expand Get an issue — response body — user

Referenced models: Get an issue — response body — user, List organizations — response body — item

Get route stats by actor — response body

Field	Type	Presence	Description and constraints
$	array	Root	API Insights usage route stats for an actor
$[]	object	Each item
$[].api_route	string	Optional	The API path's route template
$[].http_method	string	Optional	The HTTP method
$[].last_rate_limited_timestamp	JSON	Optional
$[].last_rate_limited_timestamp (anyOf 1)	string	Alternative
$[].last_rate_limited_timestamp (anyOf 2)	null	Alternative
$[].last_request_timestamp	string	Optional
$[].rate_limited_request_count	JSON	Optional
$[].rate_limited_request_count (anyOf 1)	integer	Alternative	The total number of requests that were rate limited within the queried time period Format: int64
$[].rate_limited_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].total_request_count	JSON	Optional
$[].total_request_count (anyOf 1)	integer	Alternative	The total number of requests within the queried time period Format: int64
$[].total_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get subject stats — response body

Field	Type	Presence	Description and constraints
$	array	Root	API Insights usage subject stats for an organization
$[]	object	Each item
$[].last_rate_limited_timestamp	JSON	Optional
$[].last_rate_limited_timestamp (anyOf 1)	string	Alternative
$[].last_rate_limited_timestamp (anyOf 2)	null	Alternative
$[].last_request_timestamp	string	Optional
$[].rate_limited_request_count	JSON	Optional
$[].rate_limited_request_count (anyOf 1)	integer	Alternative
$[].rate_limited_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].subject_id	JSON	Optional
$[].subject_id (anyOf 1)	integer	Alternative	Format: int64
$[].subject_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].subject_name	string	Optional
$[].subject_type	string	Optional
$[].total_request_count	JSON	Optional
$[].total_request_count (anyOf 1)	integer	Alternative
$[].total_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get summary stats — response body

Field	Type	Presence	Description and constraints
$	object	Root	API Insights usage summary stats for an organization
rate_limited_request_count	JSON	Optional
rate_limited_request_count (anyOf 1)	integer	Alternative	The total number of requests that were rate limited within the queried time period Format: int64
rate_limited_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_request_count	JSON	Optional
total_request_count (anyOf 1)	integer	Alternative	The total number of requests within the queried time period Format: int64
total_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get time stats — response body

Field	Type	Presence	Description and constraints
$	array	Root	API Insights usage time stats for an organization
$[]	object	Each item
$[].rate_limited_request_count	JSON	Optional
$[].rate_limited_request_count (anyOf 1)	integer	Alternative	Format: int64
$[].rate_limited_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].timestamp	string	Optional
$[].total_request_count	JSON	Optional
$[].total_request_count (anyOf 1)	integer	Alternative	Format: int64
$[].total_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get user stats — response body

Field	Type	Presence	Description and constraints
$	array	Root	API Insights usage stats for a user
$[]	object	Each item
$[].actor_id	JSON	Optional
$[].actor_id (anyOf 1)	integer	Alternative	Format: int64
$[].actor_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].actor_name	string	Optional
$[].actor_type	string	Optional
$[].integration_id	JSON	Optional
$[].integration_id (anyOf 1)	JSON	Alternative
$[].integration_id (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
$[].integration_id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].integration_id (anyOf 2)	null	Alternative
$[].last_rate_limited_timestamp	JSON	Optional
$[].last_rate_limited_timestamp (anyOf 1)	string	Alternative
$[].last_rate_limited_timestamp (anyOf 2)	null	Alternative
$[].last_request_timestamp	string	Optional
$[].oauth_application_id	JSON	Optional
$[].oauth_application_id (anyOf 1)	JSON	Alternative
$[].oauth_application_id (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
$[].oauth_application_id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].oauth_application_id (anyOf 2)	null	Alternative
$[].rate_limited_request_count	JSON	Optional
$[].rate_limited_request_count (anyOf 1)	integer	Alternative
$[].rate_limited_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$[].total_request_count	JSON	Optional
$[].total_request_count (anyOf 1)	integer	Alternative
$[].total_request_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List app installations for an organization — response body — installations item

Field	Type	Presence	Description and constraints
$	object	Root	Installation
access_tokens_url	string	Required within parent	Format: uri
account	JSON	Required within parent
account (anyOf 1)	JSON	Alternative
account (anyOf 1) (anyOf 1)	Model	Alternative	Expand List users — response body — item
account (anyOf 1) (anyOf 2)	Model	Alternative	Expand Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise
account (anyOf 2)	null	Alternative
app_id	JSON	Required within parent
app_id (anyOf 1)	integer	Alternative
app_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
app_slug	string	Required within parent
client_id	string	Optional
contact_email	JSON	Optional
contact_email (anyOf 1)	string	Alternative
contact_email (anyOf 2)	null	Alternative
created_at	string	Required within parent	Format: date-time
events	array	Required within parent
events[]	string	Each item
has_multiple_single_files	boolean	Optional
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The ID of the installation.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
permissions	Model	Required within parent	Expand List app installations for an organization — response body — installations item permissions
repositories_url	string	Required within parent	Format: uri
repository_selection	string	Required within parent	Describe whether all repositories have been selected or there's a selection involved Known values: all, selected
single_file_name	JSON	Required within parent
single_file_name (anyOf 1)	string	Alternative
single_file_name (anyOf 2)	null	Alternative
single_file_paths	array	Optional
single_file_paths[]	string	Each item
suspended_at	JSON	Required within parent
suspended_at (anyOf 1)	string	Alternative	Format: date-time
suspended_at (anyOf 2)	null	Alternative
suspended_by	Model	Required within parent	Expand Get an issue — response body — user
target_id	JSON	Required within parent
target_id (anyOf 1)	integer	Alternative	The ID of the user or organization this token is being scoped to.
target_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
target_type	string	Required within parent
updated_at	string	Required within parent	Format: date-time

Referenced models: List app installations for an organization — response body — installations item permissions, Get an app — response body — client id, created at, description, events, external url, html url, id, installations count, name, node id, owner, permissions, slug, updated at owner Enterprise, Get an issue — response body — user, List users — response body — item

List app installations for an organization — response body — installations item permissions

Field	Type	Presence	Description and constraints
$	object	Root	The permissions granted to the fine-grained access token.
actions	string	Optional	The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Known values: read, write
administration	string	Optional	The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Known values: read, write
artifact_metadata	string	Optional	The level of permission to grant the access token to create and retrieve build artifact metadata records. Known values: read, write
attestations	string	Optional	The level of permission to create and retrieve the access token for repository attestations. Known values: read, write
checks	string	Optional	The level of permission to grant the access token for checks on code. Known values: read, write
code_quality	string	Optional	The level of permission to grant the access token to view and manage code quality data. Known values: read, write
codespaces	string	Optional	The level of permission to grant the access token to create, edit, delete, and list Codespaces. Known values: read, write
contents	string	Optional	The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. Known values: read, write
custom_properties_for_organizations	string	Optional	The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. Known values: read, write
dependabot_secrets	string	Optional	The level of permission to grant the access token to manage Dependabot secrets. Known values: read, write
deployments	string	Optional	The level of permission to grant the access token for deployments and deployment statuses. Known values: read, write
discussions	string	Optional	The level of permission to grant the access token for discussions and related comments and labels. Known values: read, write
email_addresses	string	Optional	The level of permission to grant the access token to manage the email addresses belonging to a user. Known values: read, write
enterprise_custom_properties_for_organizations	string	Optional	The level of permission to grant the access token for organization custom properties management at the enterprise level. Known values: read, write, admin
environments	string	Optional	The level of permission to grant the access token for managing repository environments. Known values: read, write
followers	string	Optional	The level of permission to grant the access token to manage the followers belonging to a user. Known values: read, write
git_ssh_keys	string	Optional	The level of permission to grant the access token to manage git SSH keys. Known values: read, write
gpg_keys	string	Optional	The level of permission to grant the access token to view and manage GPG keys belonging to a user. Known values: read, write
interaction_limits	string	Optional	The level of permission to grant the access token to view and manage interaction limits on a repository. Known values: read, write
issues	string	Optional	The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Known values: read, write
members	string	Optional	The level of permission to grant the access token for organization teams and members. Known values: read, write
merge_queues	string	Optional	The level of permission to grant the access token to manage the merge queues for a repository. Known values: read, write
metadata	string	Optional	The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Known values: read, write
organization_administration	string	Optional	The level of permission to grant the access token to manage access to an organization. Known values: read, write
organization_announcement_banners	string	Optional	The level of permission to grant the access token to view and manage announcement banners for an organization. Known values: read, write
organization_copilot_agent_settings	string	Optional	The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization. Known values: read, write
organization_copilot_requests	string	Optional	The level of permission to grant the access token to make Copilot requests billed to the organization where the app is installed. This property is in public preview and is subject to change. Known values: read
organization_copilot_seat_management	string	Optional	The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. Known values: read, write
organization_custom_org_roles	string	Optional	The level of permission to grant the access token for custom organization roles management. Known values: read, write
organization_custom_properties	string	Optional	The level of permission to grant the access token for repository custom properties management at the organization level. Known values: read, write, admin
organization_custom_roles	string	Optional	The level of permission to grant the access token for custom repository roles management. Known values: read, write
organization_events	string	Optional	The level of permission to grant the access token to view events triggered by an activity in an organization. Known values: read
organization_external_properties_for_repos	string	Optional	The level of permission to grant the access token for managing external custom properties for repositories in an organization. Known values: read, write, admin
organization_hooks	string	Optional	The level of permission to grant the access token to manage the post-receive hooks for an organization. Known values: read, write
organization_packages	string	Optional	The level of permission to grant the access token for organization packages published to GitHub Packages. Known values: read, write
organization_personal_access_token_requests	string	Optional	The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. Known values: read, write
organization_personal_access_tokens	string	Optional	The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. Known values: read, write
organization_plan	string	Optional	The level of permission to grant the access token for viewing an organization's plan. Known values: read
organization_projects	string	Optional	The level of permission to grant the access token to manage organization projects and projects public preview (where available). Known values: read, write, admin
organization_secrets	string	Optional	The level of permission to grant the access token to manage organization secrets. Known values: read, write
organization_self_hosted_runners	string	Optional	The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Known values: read, write
organization_user_blocking	string	Optional	The level of permission to grant the access token to view and manage users blocked by the organization. Known values: read, write
packages	string	Optional	The level of permission to grant the access token for packages published to GitHub Packages. Known values: read, write
pages	string	Optional	The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Known values: read, write
profile	string	Optional	The level of permission to grant the access token to manage the profile settings belonging to a user. Known values: write
pull_requests	string	Optional	The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Known values: read, write
repository_custom_properties	string	Optional	The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. Known values: read, write
repository_hooks	string	Optional	The level of permission to grant the access token to manage the post-receive hooks for a repository. Known values: read, write
repository_projects	string	Optional	The level of permission to grant the access token to manage repository projects, columns, and cards. Known values: read, write, admin
secret_scanning_alerts	string	Optional	The level of permission to grant the access token to view and manage secret scanning alerts. Known values: read, write
secrets	string	Optional	The level of permission to grant the access token to manage repository secrets. Known values: read, write
security_events	string	Optional	The level of permission to grant the access token to view and manage security events like code scanning alerts. Known values: read, write
single_file	string	Optional	The level of permission to grant the access token to manage just a single file. Known values: read, write
starring	string	Optional	The level of permission to grant the access token to list and manage repositories a user is starring. Known values: read, write
statuses	string	Optional	The level of permission to grant the access token for commit statuses. Known values: read, write
vulnerability_alerts	string	Optional	The level of permission to grant the access token to manage Dependabot alerts. Known values: read, write
workflows	string	Optional	The level of permission to grant the access token to update GitHub Actions workflow files. Known values: write

List artifact deployment records — response body — deployment records item

Field	Type	Presence	Description and constraints
$	object	Root	Artifact Metadata Deployment Record
attestation_id	JSON	Optional
attestation_id (anyOf 1)	JSON	Alternative
attestation_id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the provenance attestation associated with the deployment record.
attestation_id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
attestation_id (anyOf 2)	null	Alternative
cluster	string	Optional
created_at	string	Optional
deployment_name	string	Optional
digest	string	Optional
id	JSON	Optional
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
logical_environment	string	Optional
physical_environment	string	Optional
runtime_risks	array	Optional	A list of runtime risks associated with the deployment. Maximum items: 4 Unique items: true
runtime_risks[]	string	Each item	Known values: critical-resource, internet-exposed, lateral-movement, sensitive-data
tags	object	Optional	Additional keys: see wildcard field
tags.*	string	Additional keys
updated_at	string	Optional

List custom property values for organization repositories — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	List of custom property values for a repository
properties	array	Required within parent	List of custom property names and associated values
properties[]	Model	Each item	Expand Get all custom property values for a repository — response body — item
repository_full_name	string	Required within parent
repository_id	JSON	Required within parent
repository_id (anyOf 1)	integer	Alternative
repository_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
repository_name	string	Required within parent

Referenced models: Get all custom property values for a repository — response body — item

List fine-grained personal access tokens with access to organization resources — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
per_page	integer	Optional	Default: 30
page	integer	Optional	Default: 1
sort	string	Optional	Default: created_at One of: created_at
direction	string	Optional	Default: desc One of: asc, desc
owner	array	Optional	Maximum items: 10
owner[]	string	Each item
repository	string	Optional
permission	string	Optional
last_used_before	string	Optional	Format: date-time
last_used_after	string	Optional	Format: date-time
token_id	array	Optional	Maximum items: 50
token_id[]	string	Each item

List fine-grained personal access tokens with access to organization resources — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Minimal representation of an organization programmatic access grant for enumerations
access_granted_at	string	Required within parent	Date and time when the fine-grained personal access token was approved to access the organization.
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
owner	Model	Required within parent	Expand List users — response body — item
permissions	object	Required within parent	Permissions requested, categorized by type of permission.
permissions.organization	object	Optional	Additional keys: see wildcard field
permissions.organization.*	string	Additional keys
permissions.other	object	Optional	Additional keys: see wildcard field
permissions.other.*	string	Additional keys
permissions.repository	object	Optional	Additional keys: see wildcard field
permissions.repository.*	string	Additional keys
repositories_url	string	Required within parent	URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`.
repository_selection	string	Required within parent	Type of repository selection requested. Known values: none, all, subset
token_expired	boolean	Required within parent	Whether the associated fine-grained personal access token has expired.
token_expires_at	JSON	Required within parent
token_expires_at (anyOf 1)	string	Alternative	Date and time when the associated fine-grained personal access token expires.
token_expires_at (anyOf 2)	null	Alternative
token_id	JSON	Required within parent
token_id (anyOf 1)	integer	Alternative	Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.
token_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
token_last_used_at	JSON	Required within parent
token_last_used_at (anyOf 1)	string	Alternative	Date and time when the associated fine-grained personal access token was last used for authentication.
token_last_used_at (anyOf 2)	null	Alternative
token_name	string	Required within parent	The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.

Referenced models: List users — response body — item

List organizations — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	A GitHub organization.
avatar_url	string	Required within parent
description	JSON	Required within parent
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
events_url	string	Required within parent	Format: uri
hooks_url	string	Required within parent
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issues_url	string	Required within parent
login	string	Required within parent
members_url	string	Required within parent
node_id	string	Required within parent
public_members_url	string	Required within parent
repos_url	string	Required within parent	Format: uri
url	string	Required within parent	Format: uri

List requests to access organization resources with fine-grained personal access tokens — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Minimal representation of an organization programmatic access grant request for enumerations
created_at	string	Required within parent	Date and time when the request for access was created.
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
owner	Model	Required within parent	Expand List users — response body — item
permissions	object	Required within parent	Permissions requested, categorized by type of permission.
permissions.organization	object	Optional	Additional keys: see wildcard field
permissions.organization.*	string	Additional keys
permissions.other	object	Optional	Additional keys: see wildcard field
permissions.other.*	string	Additional keys
permissions.repository	object	Optional	Additional keys: see wildcard field
permissions.repository.*	string	Additional keys
reason	JSON	Required within parent
reason (anyOf 1)	string	Alternative	Reason for requesting access.
reason (anyOf 2)	null	Alternative
repositories_url	string	Required within parent	URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`.
repository_selection	string	Required within parent	Type of repository selection requested. Known values: none, all, subset
token_expired	boolean	Required within parent	Whether the associated fine-grained personal access token has expired.
token_expires_at	JSON	Required within parent
token_expires_at (anyOf 1)	string	Alternative	Date and time when the associated fine-grained personal access token expires.
token_expires_at (anyOf 2)	null	Alternative
token_id	JSON	Required within parent
token_id (anyOf 1)	integer	Alternative	Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.
token_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
token_last_used_at	JSON	Required within parent
token_last_used_at (anyOf 1)	string	Alternative	Date and time when the associated fine-grained personal access token was last used for authentication.
token_last_used_at (anyOf 2)	null	Alternative
token_name	string	Required within parent	The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.

Referenced models: List users — response body — item

List security manager teams — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Groups of organization members that gives permissions on specified repositories.
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Description of the team
description (anyOf 2)	null	Alternative
enterprise_id	JSON	Optional
enterprise_id (anyOf 1)	integer	Alternative	Unique identifier of the enterprise to which this team belongs
enterprise_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the team
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ldap_dn	string	Optional	Distinguished Name (DN) that team maps to within LDAP environment
members_url	string	Required within parent
name	string	Required within parent	Name of the team
node_id	string	Required within parent
notification_setting	string	Optional	The notification setting the team has set
organization_id	JSON	Optional
organization_id (anyOf 1)	integer	Alternative	Unique identifier of the organization to which this team belongs
organization_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
permission	string	Required within parent	Permission that the team will have for its repositories
privacy	string	Optional	The level of privacy this team should have
repositories_url	string	Required within parent	Format: uri
slug	string	Required within parent
type	string	Required within parent	The ownership type of the team Known values: enterprise, organization
url	string	Required within parent	URL for the team Format: uri

List teams that are assigned to an organization role — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	The Relationship a Team has with a role.
assignment	string	Optional	Determines if the team has a direct, indirect, or mixed relationship to a role Known values: direct, indirect, mixed
description	JSON	Required within parent
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
enterprise_id	JSON	Optional
enterprise_id (anyOf 1)	integer	Alternative	Unique identifier of the enterprise to which this team belongs
enterprise_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
members_url	string	Required within parent
name	string	Required within parent
node_id	string	Required within parent
notification_setting	string	Optional
organization_id	JSON	Optional
organization_id (anyOf 1)	integer	Alternative	Unique identifier of the organization to which this team belongs
organization_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
parent	Model	Required within parent	Expand Create a team — response body — parent
permission	string	Required within parent
permissions	object	Optional
permissions.admin	boolean	Required within parent
permissions.maintain	boolean	Required within parent
permissions.pull	boolean	Required within parent
permissions.push	boolean	Required within parent
permissions.triage	boolean	Required within parent
privacy	string	Optional
repositories_url	string	Required within parent	Format: uri
slug	string	Required within parent
type	string	Required within parent	The ownership type of the team Known values: enterprise, organization
url	string	Required within parent	Format: uri

Referenced models: Create a team — response body — parent

List users that are assigned to an organization role — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	The Relationship a User has with a role.
assignment	string	Optional	Determines if the user has a direct, indirect, or mixed relationship to a role Known values: direct, indirect, mixed
avatar_url	string	Required within parent	Format: uri
email	JSON	Optional
email (anyOf 1)	string	Alternative
email (anyOf 2)	null	Alternative
events_url	string	Required within parent
followers_url	string	Required within parent	Format: uri
following_url	string	Required within parent
gists_url	string	Required within parent
gravatar_id	JSON	Required within parent
gravatar_id (anyOf 1)	string	Alternative
gravatar_id (anyOf 2)	null	Alternative
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
inherited_from	array	Optional	Team the user has gotten the role through
inherited_from[]	Model	Each item	Expand List security manager teams — response body — item
login	string	Required within parent
name	JSON	Optional
name (anyOf 1)	string	Alternative
name (anyOf 2)	null	Alternative
node_id	string	Required within parent
organizations_url	string	Required within parent	Format: uri
received_events_url	string	Required within parent	Format: uri
repos_url	string	Required within parent	Format: uri
site_admin	boolean	Required within parent
starred_at	string	Optional
starred_url	string	Required within parent
subscriptions_url	string	Required within parent	Format: uri
type	string	Required within parent
url	string	Required within parent	Format: uri
user_view_type	string	Optional

Referenced models: List security manager teams — response body — item

Register an app installation for external custom properties — response body

Field	Type	Presence	Description and constraints
$	object	Root	A GitHub App installation that has been registered to read and write an organization's external custom properties, together with the display name assigned to it.
display_name	string	Required within parent	The display name assigned to the app installation's external custom properties in the organization.
installation	object	Required within parent	The GitHub App installation that was registered.
installation.id	JSON	Required within parent
installation.id (anyOf 1)	integer	Alternative	The unique identifier of the GitHub App installation.
installation.id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a webhook configuration for an organization — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
content_type	string	Optional	The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
insecure_ssl	Model	Optional	Expand Update a webhook configuration for a repository — request body — body insecure ssl
secret	string	Optional	If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
url	string	Optional	The URL to which the payloads will be delivered. Format: uri

Referenced models: Update a webhook configuration for a repository — request body — body insecure ssl

Update issue field for an organization — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	JSON	Optional
description (anyOf 1)	string	Alternative	Description of the issue field.
description (anyOf 2)	null	Alternative
name	string	Optional	Name of the issue field.
options	array	Optional	Options for select fields. Only applicable when updating single_select or multi_select fields. When provided, this array **replaces** the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its `id`. Options sent without an `id` are treated as new options and may cause existing options to be deleted and recreated.
options[]	object	Each item
options[].color	string	Required within parent	Color for the option. One of: gray, blue, green, yellow, orange, red, pink, purple
options[].description	JSON	Optional
options[].description (anyOf 1)	string	Alternative	Description of the option.
options[].description (anyOf 2)	null	Alternative
options[].id	integer	Optional	The id of an existing option to retain or update. Omit this when creating a new option.
options[].name	string	Required within parent	Name of the option.
options[].priority	integer	Required within parent	Priority of the option for ordering.
visibility	string	Optional	The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled. One of: organization_members_only, all