カスタム プロパティの REST API エンドポイント

Gets the registered GitHub App installations used to read and write external custom properties for an organization.

A GitHub App installation token will only be able to see its own registration info, whereas an authenticated user will be able to see all registrations for the organization.

To use this endpoint, the authenticated caller must have the organization_external_properties_for_repos:admin permission.

Registers a GitHub App installation so it can read and write external custom properties for an organization, and assigns it a display name.

The display name must be 1 to 15 characters and contain only letters and numbers. Capitalization is preserved as entered.

An app installation can only be registered once, and its display name can't be changed afterward. Calling with an app installation that has already been registered returns a 422 response with an already_exists error code for installation_id. If the display name is already in use by another app installation in the organization, the response is 422 with an already_exists error code for display_name. An invalid display name also returns 422.

The app installation being registered must have write or admin permission for organization external custom properties for repositories. If it doesn't, the response is 422. This is the permission of the installation being registered, which isn't necessarily the caller.

Uninstalling the GitHub App unregisters it, and removes the external custom properties it created.

To use this endpoint, the authenticated caller must have the organization_external_properties_for_repos:admin permission.

Gets all external custom properties defined for the authenticated GitHub App installation on an organization.

To use this endpoint, the authenticated GitHub App must have the organization_external_properties_for_repos:read permission.

Create new or update existing external custom property values for repositories in a batch that belong to an organization. Each target repository will have its external custom property values updated to match the values provided in the request.

A maximum of 30 repositories can be updated in a single request.

Using a value of null for an external custom property will remove or 'unset' the property value from the repository.

To use this endpoint, the authenticated GitHub App must have the organization_external_properties_for_repos:write permission.

Create new or update existing external custom property values for a single named property across repositories that belong to an organization.

Up to 100 repository values can be updated in a single request. Repositories not included in the request are left unchanged.

Using a value of null for a repository will remove or 'unset' the property value for that repository. A request that only contains null values for a property that does not yet exist is a no-op.

To use this endpoint, the authenticated GitHub App must have the organization_external_properties_for_repos:write permission.

Removes all external custom property values for a specified property name across all repositories that belong to an organization.

To use this endpoint, the authenticated GitHub App must have the organization_external_properties_for_repos:write permission.

Gets all custom properties defined for an organization. Organization members can read these properties.

Creates new or updates existing custom properties defined for an organization in a batch.

If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. E.g. if a property exists with values_editable_by: org_and_repo_actors and it's updated without specifying values_editable_by, it will be updated to default value org_actors.

To use this endpoint, the authenticated user must be one of:

• An administrator for the organization.
• A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.

Gets a custom property that is defined for an organization. Organization members can read these properties.

Creates a new or updates an existing custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:

• An administrator for the organization.
• A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.

Removes a custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:

• An administrator for the organization.
• A user, or a user on a team, with the fine-grained permission of custom_properties_org_definitions_manager in the organization.

Lists organization repositories with all of their custom property values. Organization members can read these properties.

Create new or update existing custom property values for repositories in a batch that belong to an organization. Each target repository will have its custom property values updated to match the values provided in the request.

A maximum of 30 repositories can be updated in a single request.

Using a value of null for a custom property will remove or 'unset' the property value from the repository.

To use this endpoint, the authenticated user must be one of:

• An administrator for the organization.
• A user, or a user on a team, with the fine-grained permission of custom_properties_org_values_editor in the organization.