Chapter 23. team

23.1. getOrganizationTeamPermissions
Link kopieren

Returns the list of repository permissions for the org’s team.

GET /api/v1/organization/{orgname}/team/{teamname}/permissions

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	teamname required	The name of the team	string
path	orgname required	The name of the organization	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/permissions"

$ curl -X GET \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/permissions"

Copy to Clipboard

Toggle word wrap

23.2. updateOrganizationTeamMember
Link kopieren

Adds or invites a member to an existing team.

PUT /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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>"

$ curl -X PUT \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"

Copy to Clipboard

Toggle word wrap

23.3. deleteOrganizationTeamMember
Link kopieren

Delete a member of a team.

If the user is merely invited to join the team, then the invite is removed instead.

If the user is merely invited to join the team, then the invite is removed instead.

Copy to Clipboard

Toggle word wrap

DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

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

Responses

Expand

HTTP Code	Description	Schema
204	Deleted
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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>"

$ curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"

Copy to Clipboard

Toggle word wrap

23.4. getOrganizationTeamMembers
Link kopieren

Retrieve the list of members for the specified team.

GET /api/v1/organization/{orgname}/team/{teamname}/members

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	teamname required	The name of the team	string
path	orgname required	The name of the organization	string

Query parameters

Expand

Type	Name	Description	Schema
query	includePending optional	Whether to include pending members	boolean

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X GET \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members"

$ curl -X GET \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members"

Copy to Clipboard

Toggle word wrap

23.5. inviteTeamMemberEmail
Link kopieren

Invites an email address to an existing team.

PUT /api/v1/organization/{orgname}/team/{teamname}/invite/{email}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Schema
path	email required	string
path	teamname required	string
path	orgname required	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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>"

$ curl -X PUT \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"

Copy to Clipboard

Toggle word wrap

23.6. deleteTeamMemberEmailInvite
Link kopieren

Delete an invite of an email address to join a team.

DELETE /api/v1/organization/{orgname}/team/{teamname}/invite/{email}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Schema
path	email required	string
path	teamname required	string
path	orgname required	string

Responses

Expand

HTTP Code	Description	Schema
204	Deleted
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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>"

$ curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"

Copy to Clipboard

Toggle word wrap

23.7. updateOrganizationTeam
Link kopieren

Update the org-wide permission for the specified team.

Note

This API is also used to create a team.

PUT /api/v1/organization/{orgname}/team/{teamname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	teamname required	The name of the team	string
path	orgname required	The name of the organization	string

Request body schema (application/json)

Description of a team

Expand

Name	Description	Schema
role required	Org wide permissions that should apply to the team	string
description optional	Markdown description for the team	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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>

$ 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>

Copy to Clipboard

Toggle word wrap

23.8. deleteOrganizationTeam
Link kopieren

Delete the specified team.

DELETE /api/v1/organization/{orgname}/team/{teamname}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	teamname required	The name of the team	string
path	orgname required	The name of the organization	string

Responses

Expand

HTTP Code	Description	Schema
204	Deleted
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"

$ curl -X DELETE \
  -H "Authorization: Bearer <your_access_token>" \
  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"

Copy to Clipboard

Toggle word wrap

Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.

23.1. getOrganizationTeamPermissionsLink kopierenLink in die Zwischenablage kopiert!

GET /api/v1/organization/{orgname}/team/{teamname}/permissions

Path parameters

Responses

Example command

23.2. updateOrganizationTeamMemberLink kopierenLink in die Zwischenablage kopiert!

PUT /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

Path parameters

Responses

Example command

23.3. deleteOrganizationTeamMemberLink kopierenLink in die Zwischenablage kopiert!

DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername}

Path parameters

Responses

Example command

23.4. getOrganizationTeamMembersLink kopierenLink in die Zwischenablage kopiert!

GET /api/v1/organization/{orgname}/team/{teamname}/members

Path parameters

Query parameters

Responses

Example command

23.5. inviteTeamMemberEmailLink kopierenLink in die Zwischenablage kopiert!

PUT /api/v1/organization/{orgname}/team/{teamname}/invite/{email}

Path parameters

Responses

Example command

23.6. deleteTeamMemberEmailInviteLink kopierenLink in die Zwischenablage kopiert!

DELETE /api/v1/organization/{orgname}/team/{teamname}/invite/{email}

Path parameters

Responses

Example command

23.7. updateOrganizationTeamLink kopierenLink in die Zwischenablage kopiert!

PUT /api/v1/organization/{orgname}/team/{teamname}

Path parameters

Request body schema (application/json)

Responses

Example command

23.8. deleteOrganizationTeamLink kopierenLink in die Zwischenablage kopiert!

DELETE /api/v1/organization/{orgname}/team/{teamname}

Path parameters

Responses

Example command

Lernen

Testen, kaufen und verkaufen

Communitys

Über Red Hat Dokumentation

Mehr Inklusion in Open Source

Über Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

23.1. getOrganizationTeamPermissions
Link kopieren

23.2. updateOrganizationTeamMember
Link kopieren

23.3. deleteOrganizationTeamMember
Link kopieren

23.4. getOrganizationTeamMembers
Link kopieren

23.5. inviteTeamMemberEmail
Link kopieren

23.6. deleteTeamMemberEmailInvite
Link kopieren

23.7. updateOrganizationTeam
Link kopieren

23.8. deleteOrganizationTeam
Link kopieren