REST API endpoints for enterprise access verification

Use the REST API to manage enterprise access verification configuration in your GitHub enterprise.

Disable access restrictions for an enterprise

Disable access restriction by proxy header using the network proxy owned by the enterprise.

Jetons d’accès affinés pour « Disable access restrictions for an enterprise »

Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.

Paramètres pour « Disable access restrictions 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.

Codes d’état de la réponse HTTP pour « Disable access restrictions for an enterprise »

Code d’état	Description
`200`	OK
`400`	Forbidden
`404`	Resource not found
`500`	Internal Error

Exemples de code pour « Disable access restrictions 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

post/enterprises/{enterprise}/access-restrictions/disable

curl -L \
  -X POST \
  -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/access-restrictions/disable

Response

Status: 200

{
  "message": "Enterprise access restrictions successfully disabled.",
  "header_name": "sec-GitHub-allowed-enterprise",
  "header_value": "12345"
}

Enable access restrictions for an enterprise

Enable access restriction by proxy header using the network proxy owned by the enterprise.

Jetons d’accès affinés pour « Enable access restrictions for an enterprise »

Paramètres pour « Enable access restrictions 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.

Codes d’état de la réponse HTTP pour « Enable access restrictions for an enterprise »

Code d’état	Description
`200`	OK
`400`	Forbidden
`404`	Resource not found
`500`	Internal Error

Exemples de code pour « Enable access restrictions 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

post/enterprises/{enterprise}/access-restrictions/enable

curl -L \
  -X POST \
  -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/access-restrictions/enable

Response

Status: 200

{
  "message": "Enterprise access restrictions successfully enabled.",
  "header_name": "sec-GitHub-allowed-enterprise",
  "header_value": "12345"
}