Propriétés personnalisées

Get custom properties for an enterprise

Note

This endpoint is in public preview and is subject to change.

Gets all custom properties defined for an enterprise. Enterprise members can read these properties.

Jetons d’accès affinés pour « Get custom properties for an enterprise »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Custom properties" business permissions (read)

Paramètres pour « Get custom properties for an enterprise »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`enterprise` string Obligatoire The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Codes d’état de la réponse HTTP pour « Get custom properties for an enterprise »

Code d’état	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « Get custom properties for an enterprise »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

get/enterprises/{enterprise}/properties/schema

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/enterprises/ENTERPRISE/properties/schema

Response

Status: 200

[
  {
    "property_name": "environment",
    "url": "https://api.github.com/orgs/github/properties/schema/environment",
    "source_type": "organization",
    "value_type": "single_select",
    "required": true,
    "default_value": "production",
    "description": "Prod or dev environment",
    "allowed_values": [
      "production",
      "development"
    ],
    "values_editable_by": "org_actors"
  },
  {
    "property_name": "service",
    "url": "https://api.github.com/orgs/github/properties/schema/service",
    "source_type": "organization",
    "value_type": "string"
  },
  {
    "property_name": "team",
    "url": "https://api.github.com/orgs/github/properties/schema/team",
    "source_type": "organization",
    "value_type": "string",
    "description": "Team owning the repository"
  }
]

Create or update custom properties for an enterprise

Note

This endpoint is in public preview and is subject to change.

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

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Jetons d’accès affinés pour « Create or update custom properties for an enterprise »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Custom properties" business permissions (write)

Paramètres pour « Create or update custom properties for an enterprise »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`enterprise` string Obligatoire The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Nom, Type, Description

properties array of objects Obligatoire

The array of custom properties to create or update.

Properties of properties

Nom, Type, Description
`property_name` string Obligatoire The name of the property
`url` string The URL that can be used to fetch, update, or delete info about this property via the API.
`source_type` string The source type of the property Peut être: `organization`, `enterprise`
`value_type` string Obligatoire The type of the value for the property Peut être: `string`, `single_select`, `multi_select`, `true_false`
`required` boolean Whether the property is required.
`default_value` null or string or array Default value of the property
`description` string or null Short description of the property
`allowed_values` array of strings or null An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
`values_editable_by` string or null Who can edit the values of the property Peut être: `org_actors`, `org_and_repo_actors`, `null`

Codes d’état de la réponse HTTP pour « Create or update custom properties for an enterprise »

Code d’état	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « Create or update custom properties for an enterprise »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

patch/enterprises/{enterprise}/properties/schema

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/enterprises/ENTERPRISE/properties/schema \
  -d '{"properties":[{"property_name":"environment","value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"],"values_editable_by":"org_actors"},{"property_name":"service","value_type":"string"},{"property_name":"team","value_type":"string","description":"Team owning the repository"}]}'

Response

Status: 200

[
  {
    "property_name": "environment",
    "url": "https://api.github.com/orgs/github/properties/schema/environment",
    "source_type": "organization",
    "value_type": "single_select",
    "required": true,
    "default_value": "production",
    "description": "Prod or dev environment",
    "allowed_values": [
      "production",
      "development"
    ],
    "values_editable_by": "org_actors"
  },
  {
    "property_name": "service",
    "url": "https://api.github.com/orgs/github/properties/schema/service",
    "source_type": "organization",
    "value_type": "string"
  },
  {
    "property_name": "team",
    "url": "https://api.github.com/orgs/github/properties/schema/team",
    "source_type": "organization",
    "value_type": "string",
    "description": "Team owning the repository"
  }
]

Get a custom property for an enterprise

Note

This endpoint is in public preview and is subject to change.

Gets a custom property that is defined for an enterprise. Enterprise members can read these properties.

Jetons d’accès affinés pour « Get a custom property for an enterprise »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Custom properties" business permissions (read)

Paramètres pour « Get a custom property for an enterprise »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`enterprise` string Obligatoire The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`custom_property_name` string Obligatoire The custom property name

Codes d’état de la réponse HTTP pour « Get a custom property for an enterprise »

Code d’état	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « Get a custom property for an enterprise »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

get/enterprises/{enterprise}/properties/schema/{custom_property_name}

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/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME

Response

Status: 200

{
  "property_name": "environment",
  "url": "https://api.github.com/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

Create or update a custom property for an enterprise

Note

This endpoint is in public preview and is subject to change.

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

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Jetons d’accès affinés pour « Create or update a custom property for an enterprise »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Custom properties" business permissions (write)

Paramètres pour « Create or update a custom property for an enterprise »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`enterprise` string Obligatoire The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`custom_property_name` string Obligatoire The custom property name

Paramètres du corps
Nom, Type, Description
`value_type` string Obligatoire The type of the value for the property Peut être: `string`, `single_select`, `multi_select`, `true_false`
`required` boolean Whether the property is required.
`default_value` null or string or array Default value of the property
`description` string or null Short description of the property
`allowed_values` array of strings or null An ordered list of the allowed values of the property. The property can have up to 200 allowed values.

Codes d’état de la réponse HTTP pour « Create or update a custom property for an enterprise »

Code d’état	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « Create or update a custom property for an enterprise »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

put/enterprises/{enterprise}/properties/schema/{custom_property_name}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME \
  -d '{"value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"]}'

Response

Status: 200

{
  "property_name": "environment",
  "url": "https://api.github.com/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

Remove a custom property for an enterprise

Note

This endpoint is in public preview and is subject to change.

Remove a custom property that is defined for an enterprise.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Jetons d’accès affinés pour « Remove a custom property for an enterprise »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Custom properties" business permissions (write)

Paramètres pour « Remove a custom property for an enterprise »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`enterprise` string Obligatoire The slug version of the enterprise name. You can also substitute this value with the enterprise id.
`custom_property_name` string Obligatoire The custom property name

Codes d’état de la réponse HTTP pour « Remove a custom property for an enterprise »

Code d’état	Description
`204`	A header with no content is returned.
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « Remove a custom property for an enterprise »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

delete/enterprises/{enterprise}/properties/schema/{custom_property_name}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME

A header with no content is returned.

Status: 204