6.19. Managing teams by using the API

Prerequisites

• You have Created an OAuth access token.

Procedure

• Enter the PUT /api/v1/organization/{orgname}/team/{teamname}/members/{membername} command to add or invite a member to an existing team:

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

  Example output

  {"name": "testuser", "kind": "user", "is_robot": false, "avatar": {"name": "testuser", "hash": "d51d17303dc3271ac3266fb332d7df919bab882bbfc7199d2017a4daac8979f0", "color": "#5254a3", "kind": "user"}, "invited": false}

• Enter the DELETE /api/v1/organization/{orgname}/team/{teamname}/members/{membername} command to remove a member of a team:

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

  This command does not an output in the CLI. To ensure that a member has been deleted, you can enter the GET /api/v1/organization/{orgname}/team/{teamname}/members command and ensure that the member is not returned in the output.

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

  Example output

  {"name": "owners", "members": [{"name": "quayadmin", "kind": "user", "is_robot": false, "avatar": {"name": "quayadmin", "hash": "b28d563a6dc76b4431fc7b0524bbff6b810387dac86d9303874871839859c7cc", "color": "#17becf", "kind": "user"}, "invited": false}, {"name": "test-org+test", "kind": "user", "is_robot": true, "avatar": {"name": "test-org+test", "hash": "aa85264436fe9839e7160bf349100a9b71403a5e9ec684d5b5e9571f6c821370", "color": "#8c564b", "kind": "robot"}, "invited": false}], "can_edit": true}

• You can enter the PUT /api/v1/organization/{orgname}/team/{teamname}/invite/{email} command to invite a user, by email address, to an existing team:

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

• You can enter the DELETE /api/v1/organization/{orgname}/team/{teamname}/invite/{email} command to delete the invite of an email address to join a team. For example:

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