REST API endpoints for an organization's custom property values

Use the REST API to manage custom properties for an organization

Get all custom property values for an organization

Gets all custom property values that are set for an organization.

The organization must belong to an enterprise.

Access requirements:

Organization admins
OAuth tokens and personal access tokens (classic) with the read:org scope
Actors with the organization-level "read custom properties for an organization" fine-grained permission or above

Подробные маркеры доступа для "Get all custom property values for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Custom properties for organizations" organization permissions (read)

Параметры для "Get all custom property values for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Коды состояния http-ответа для "Get all custom property values for an organization"

Код состояния	Описание
`200`	OK
`403`	Forbidden
`404`	Resource not found

Примеры кода для "Get all custom property values for an organization"

Пример запроса

get/organizations/{org}/org-properties/values

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/organizations/ORG/org-properties/values

Response

Status: 200

[
  {
    "property_name": "environment",
    "value": "production"
  },
  {
    "property_name": "service",
    "value": "web"
  },
  {
    "property_name": "team",
    "value": "octocat"
  }
]

Create or update custom property values for an organization

Create new or update existing custom property values for an organization. To remove a custom property value from an organization, set the property value to null.

The organization must belong to an enterprise.

Access requirements:

Organization admins
OAuth tokens and personal access tokens (classic) with the admin:org scope
Actors with the organization-level "edit custom properties for an organization" fine-grained permission

Подробные маркеры доступа для "Create or update custom property values for an organization

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Custom properties for organizations" organization permissions (write)

Параметры для "Create or update custom property values for an organization"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`org` string Обязательное поле The organization name. The name is not case sensitive.

Имя., Тип, Description

properties array of objects Обязательное поле

A list of custom property names and associated values to apply to the organization.

Properties of properties

Имя., Тип, Description
`property_name` string Обязательное поле The name of the property
`value` null or string or array Обязательное поле The value assigned to the property

Коды состояния http-ответа для "Create or update custom property values for an organization"

Код состояния	Описание
`204`	No Content when custom property values are successfully created or updated
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "Create or update custom property values for an organization"

Пример запроса

patch/organizations/{org}/org-properties/values

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/organizations/ORG/org-properties/values \
  -d '{"properties":[{"property_name":"environment","value":"production"},{"property_name":"service","value":"web"},{"property_name":"team","value":"octocat"}]}'

No Content when custom property values are successfully created or updated

Status: 204