a340162d84
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: Peter Bengtsson <peterbe@github.com>
33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
---
|
|
title: Collaborators
|
|
intro: 'The collaborators API allows you to add, invite, and remove collaborators from a repository.'
|
|
allowTitleToDifferFromFilename: true
|
|
versions:
|
|
fpt: '*'
|
|
ghes: '*'
|
|
ghae: '*'
|
|
ghec: '*'
|
|
topics:
|
|
- API
|
|
miniTocMaxHeadingLevel: 3
|
|
---
|
|
|
|
{% for operation in currentRestOperations %}
|
|
{% unless operation.subcategory %}{% include rest_operation %}{% endunless %}
|
|
{% endfor %}
|
|
|
|
## Invitations
|
|
|
|
The Repository Invitations API allows users or external services to invite other users to collaborate on a repo. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations.
|
|
|
|
Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted
|
|
access to invitations **without** also granting access to repository code, while the
|
|
`repo` scope grants permission to code as well as invitations.
|
|
|
|
### Invite a user to a repository
|
|
|
|
Use the API endpoint for adding a collaborator. For more information, see "[Add a repository collaborator](/rest/reference/collaborators#add-a-repository-collaborator)."
|
|
|
|
{% for operation in currentRestOperations %}
|
|
{% if operation.subcategory == 'invitations' %}{% include rest_operation %}{% endif %}
|
|
{% endfor %} |