Points de terminaison d’API REST pour les collaborateurs externes

List outside collaborators for an organization

List all users who are outside collaborators of an organization.

Jetons d’accès affinés pour « List outside collaborators for an organization »

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

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

"Members" organization permissions (read)

Paramètres pour « List outside collaborators for an organization »

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
`org` string Obligatoire The organization name. The name is not case sensitive.

Paramètres de requête
Nom, Type, Description
`filter` string Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without two-factor authentication enabled will be returned. Default: `all` Peut être: `2fa_disabled`, `all`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1`

Codes d’état de la réponse HTTP pour « List outside collaborators for an organization »

Code d’état	Description
`200`	OK

Exemples de code pour « List outside collaborators for an organization »

Exemple de requête

get/orgs/{org}/outside_collaborators

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/orgs/ORG/outside_collaborators

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Convert an organization member to outside collaborator

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "Converting an organization member to an outside collaborator". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "Enforcing repository management policies in your enterprise."

Jetons d’accès affinés pour « Convert an organization member to outside collaborator »

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

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

"Members" organization permissions (write)

Paramètres pour « Convert an organization member to outside collaborator »

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
`org` string Obligatoire The organization name. The name is not case sensitive.
`username` string Obligatoire The handle for the GitHub user account.

Paramètres du corps
Nom, Type, Description
`async` boolean When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. Default: `false`

Codes d’état de la réponse HTTP pour « Convert an organization member to outside collaborator »

Code d’état	Description
`202`	User is getting converted asynchronously
`204`	User was converted
`403`	Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "Enforcing repository management policies in your enterprise."
`404`	Resource not found

Exemples de code pour « Convert an organization member to outside collaborator »

Exemples de requête

Select the example type

put/orgs/{org}/outside_collaborators/{username}

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/orgs/ORG/outside_collaborators/USERNAME \
  -d '{"async":true}'

User is getting converted asynchronously

Status: 202

Remove outside collaborator from an organization

Removing a user from this list will remove them from all the organization's repositories.

Jetons d’accès affinés pour « Remove outside collaborator from an organization »

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

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

"Members" organization permissions (write)

Paramètres pour « Remove outside collaborator from an organization »

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
`org` string Obligatoire The organization name. The name is not case sensitive.
`username` string Obligatoire The handle for the GitHub user account.

Codes d’état de la réponse HTTP pour « Remove outside collaborator from an organization »

Code d’état	Description
`204`	No Content
`422`	Unprocessable Entity if user is a member of the organization

Exemples de code pour « Remove outside collaborator from an organization »

Exemple de requête

delete/orgs/{org}/outside_collaborators/{username}

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/orgs/ORG/outside_collaborators/USERNAME

Response

Status: 204