managing-user-options-api.adoc

Managing current user options by using the {productname} API

Some user options, like starring a repository, or getting information about your account, are available with the {productname} API.

Procedure

1. Use the GET /api/v1/user/ endpoint to get user information for the authenticated user.

   $ curl -X GET "https://quay-server.example.com/api/v1/user/" \
     -H "Authorization: Bearer <your_access_token>"
   Example output

   {"anonymous": false, "username": "quayadmin", "avatar": {"name": "quayadmin", "hash": "6d640d802fe23b93779b987c187a4b7a4d8fbcbd4febe7009bdff58d84498fba", "color": "#f7b6d2", "kind": "user"}, "can_create_repo": true, "is_me": true, "verified": true, "email": "test@gmil.com", "logins": [], "invoice_email": false, "invoice_email_address": null, "preferred_namespace": false, "tag_expiration_s": 1209600, "prompts": [], "company": null, "family_name": null, "given_name": null, "location": null, "is_free_account": true, "has_password_set": true, "quotas": [{"id": 4, "limit_bytes": 2199023255552, "limits": [{"id": 3, "type": "Reject", "limit_percent": 100}]}], "quota_report": {"quota_bytes": 2280675, "configured_quota": 2199023255552, "running_backfill": "complete", "backfill_status": "complete"}, "organizations": [{"name": "test", "avatar": {"name": "test", "hash": "a15d479002b20f211568fd4419e76686d2b88a4980a5b4c4bc10420776c5f6fe", "color": "#aec7e8", "kind": "org"}, "can_create_repo": true, "public": false, "is_org_admin": true, "preferred_namespace": false}, {"name": "sample", "avatar": {"name": "sample", "hash": "ba560c68f1d26e8c6b911ac9b5d10d513e7e43e576cc2baece1b8a46f36a29a5", "color": "#b5cf6b", "kind": "org"}, "can_create_repo": true, "public": false, "is_org_admin": true, "preferred_namespace": false}], "super_user": true}

2. Use the GET /api/v1/users/{username} endpoint to get user information for the specified user.

   $ curl -X GET "https://quay-server.example.com/api/v1/users/example_user" \
     -H "Authorization: Bearer <your_access_token>"
   Example output

   {"anonymous": false, "username": "testuser", "avatar": {"name": "testuser", "hash": "f660ab912ec121d1b1e928a0bb4bc61b15f5ad44d5efdc4e1c92a25e99b8e44a", "color": "#6b6ecf", "kind": "user"}, "super_user": false}

3. Use the POST /api/v1/user/starred endpoint to star a repository:

   $ curl -X POST "https://quay-server.example.com/api/v1/user/starred" \
     -H "Authorization: Bearer <your_access_token>" \
     -H "Content-Type: application/json" \
     -d '{
           "namespace": "<namespace>",
           "repository": "<repository_name>"
         }'
   Example output

   {"namespace": "test", "repository": "testrepo"}

4. Use the GET /api/v1/user/starred endpoint to list all starred repositories:

   $ curl -X GET "https://quay-server.example.com/api/v1/user/starred?next_page=<next_page_token>" \
     -H "Authorization: Bearer <your_access_token>"
   Example output

   {"repositories": [{"namespace": "test", "name": "testrepo", "description": "This repository is now under maintenance.", "is_public": true}]}

5. Use the DELETE /api/v1/user/starred/{repository} endpoint to delete a star from a repository:

   $ curl -X DELETE "https://quay-server.example.com/api/v1/user/starred/namespace/repository-name" \
     -H "Authorization: Bearer <your_access_token>"

   This command does not return output in the CLI.