Chapter 30. user
Manage the current user.
30.1. createStar Copy linkLink copied to clipboard!
Star a repository.
30.1.1. POST /api/v1/user/starred Copy linkLink copied to clipboard!
Authorizations: oauth2_implicit (repo:read)
30.1.2. Request body schema (application/json) Copy linkLink copied to clipboard!
| Name | Description | Schema |
|---|---|---|
| namespace required | Namespace in which the repository belongs | string |
| repository required | Repository name | string |
30.1.3. Responses Copy linkLink copied to clipboard!
30.1.4. Example command Copy linkLink copied to clipboard!
$ 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>"
}'
30.2. listStarredRepos Copy linkLink copied to clipboard!
List all starred repositories.
30.2.1. GET /api/v1/user/starred Copy linkLink copied to clipboard!
Authorizations: oauth2_implicit (user:admin)
30.2.2. Query parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| query | next_page optional | The page token for the next page | string |
30.2.3. Responses Copy linkLink copied to clipboard!
30.2.4. Example command Copy linkLink copied to clipboard!
$ curl -X GET "https://quay-server.example.com/api/v1/user/starred?next_page=<next_page_token>" \
-H "Authorization: Bearer <your_access_token>"
30.3. getLoggedInUser Copy linkLink copied to clipboard!
Get user information for the authenticated user.
30.3.1. GET /api/v1/user/ Copy linkLink copied to clipboard!
Authorizations: oauth2_implicit (user:read)
30.3.2. Responses Copy linkLink copied to clipboard!
30.3.3. Example command Copy linkLink copied to clipboard!
$ curl -X GET "https://quay-server.example.com/api/v1/user/" \
-H "Authorization: Bearer <your_access_token>"
30.4. deleteStar Copy linkLink copied to clipboard!
Removes a star from a repository.
30.4.1. DELETE /api/v1/user/starred/{repository} Copy linkLink copied to clipboard!
Authorizations: oauth2_implicit (user:admin)
30.4.2. Path parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
30.4.3. Responses Copy linkLink copied to clipboard!
30.4.4. Example command Copy linkLink copied to clipboard!
$ curl -X DELETE "https://quay-server.example.com/api/v1/user/starred/namespace/repository-name" \
-H "Authorization: Bearer <your_access_token>"
30.5. getUserInformation Copy linkLink copied to clipboard!
Get user information for the specified user.
30.5.1. GET /api/v1/users/{username} Copy linkLink copied to clipboard!
Authorizations:
30.5.2. Path parameters Copy linkLink copied to clipboard!
| Type | Name | Description | Schema |
|---|---|---|---|
| path | username required | string |
30.5.3. Responses Copy linkLink copied to clipboard!
30.5.4. Example command Copy linkLink copied to clipboard!
$ curl -X GET "https://quay-server.example.com/api/v1/users/example_user" \
-H "Authorization: Bearer <your_access_token>"