Chapter 28. team
Create, list and manage an organization’s teams.
28.1. getOrganizationTeamPermissions
Returns the list of repository permissions for the org’s team.
28.1.1. GET /api/v1/organization/{orgname}/team/{teamname}/permissions
Authorizations:
28.1.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | teamname required | The name of the team | string |
| path | orgname required | The name of the organization | string |
28.1.3. Responses
28.1.4. Example command
$ curl -X GET \
-H "Authorization: Bearer <your_access_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/permissions"28.2. updateOrganizationTeamMember
Adds or invites a member to an existing team.
28.2.1. PUT /api/v1/organization/{orgname}/team/{teamname}/members/{membername}
Authorizations: oauth2_implicit (org:admin)
28.2.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | teamname required | The name of the team | string |
| path | membername required | The username of the team member | string |
| path | orgname required | The name of the organization | string |
28.2.3. Responses
28.2.4. Example command
$ curl -X PUT \
-H "Authorization: Bearer <your_access_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"28.3. deleteOrganizationTeamMember
Delete a member of a team.
If the user is merely invited to join the team, then the invite is removed instead.28.3.1. DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername}
Authorizations: oauth2_implicit (org:admin)
28.3.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | teamname required | The name of the team | string |
| path | membername required | The username of the team member | string |
| path | orgname required | The name of the organization | string |
28.3.3. Responses
28.3.4. Example command
$ curl -X DELETE \
-H "Authorization: Bearer <your_access_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"28.4. getOrganizationTeamMembers
Retrieve the list of members for the specified team.
28.4.1. GET /api/v1/organization/{orgname}/team/{teamname}/members
Authorizations: oauth2_implicit (org:admin)
28.4.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | teamname required | The name of the team | string |
| path | orgname required | The name of the organization | string |
28.4.3. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | includePending optional | Whether to include pending members | boolean |
28.4.4. Responses
28.4.5. Example command
$ curl -X GET \
-H "Authorization: Bearer <your_access_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members"28.5. inviteTeamMemberEmail
Invites an email address to an existing team.
28.5.1. PUT /api/v1/organization/{orgname}/team/{teamname}/invite/{email}
Authorizations: oauth2_implicit (org:admin)
28.5.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | required | string | |
| path | teamname required | string | |
| path | orgname required | string |
28.5.3. Responses
28.5.4. Example command
$ curl -X PUT \
-H "Authorization: Bearer <your_access_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"28.6. deleteTeamMemberEmailInvite
Delete an invite of an email address to join a team.
28.6.1. DELETE /api/v1/organization/{orgname}/team/{teamname}/invite/{email}
Authorizations: oauth2_implicit (org:admin)
28.6.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | required | string | |
| path | teamname required | string | |
| path | orgname required | string |
28.6.3. Responses
28.6.4. Example command
+
$ curl -X DELETE \
-H "Authorization: Bearer <your_access_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"28.7. updateOrganizationTeam
Update the org-wide permission for the specified team.
This API is also used to create a team.
28.7.1. PUT /api/v1/organization/{orgname}/team/{teamname}
Authorizations: oauth2_implicit (org:admin)
28.7.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | teamname required | The name of the team | string |
| path | orgname required | The name of the organization | string |
28.7.3. Request body schema (application/json)
Description of a team
| Name | Description | Schema |
|---|---|---|
| role required | Org wide permissions that should apply to the team | string |
| description optional | Markdown description for the team | string |
28.7.4. Responses
28.7.5. Example command
$ curl -k -X PUT -H 'Accept: application/json' -H 'Content-Type: application/json' -H "Authorization: Bearer <bearer_token>" --data '{"role": "creator"}' https://<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>28.8. deleteOrganizationTeam
Delete the specified team.
28.8.1. DELETE /api/v1/organization/{orgname}/team/{teamname}
Authorizations: oauth2_implicit (org:admin)
28.8.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | teamname required | The name of the team | string |
| path | orgname required | The name of the organization | string |
28.8.3. Responses
28.8.4. Example command
$ curl -X DELETE \
-H "Authorization: Bearer <your_access_token>" \
"<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}