Chapter 25. user

25.1. createStar
Copy link

Star a repository.

POST /api/v1/user/starred

Authorizations: oauth2_implicit (repo:read)

Request body schema (application/json)

Expand

Name	Description	Schema
namespace required	Namespace in which the repository belongs	string
repository required	Repository name	string

Responses

Expand

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

Example command

curl -X POST "https://quay-server.example.com/api/v1/user/starred" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{

$ 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>"
      }'

Copy to Clipboard

Toggle word wrap

25.2. listStarredRepos
Copy link

List all starred repositories.

GET /api/v1/user/starred

Authorizations: oauth2_implicit (user:admin)

Query parameters

Expand

Type	Name	Description	Schema
query	next_page optional	The page token for the next page	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 "https://quay-server.example.com/api/v1/user/starred?next_page=<next_page_token>" \
  -H "Authorization: Bearer <your_access_token>"

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

Copy to Clipboard

Toggle word wrap

25.3. getLoggedInUser
Copy link

Get user information for the authenticated user.

GET /api/v1/user/

Authorizations: oauth2_implicit (user:read)

Responses

Expand

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

Example command

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

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

Copy to Clipboard

Toggle word wrap

25.4. deleteStar
Copy link

Removes a star from a repository.

DELETE /api/v1/user/starred/{repository}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	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 "https://quay-server.example.com/api/v1/user/starred/namespace/repository-name" \
  -H "Authorization: Bearer <your_access_token>"

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

Copy to Clipboard

Toggle word wrap

25.5. getUserInformation
Copy link

Get user information for the specified user.

GET /api/v1/users/{username}

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	username 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 GET "https://quay-server.example.com/api/v1/users/example_user" \
  -H "Authorization: Bearer <your_access_token>"

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

Copy to Clipboard

Toggle word wrap

25.1. createStar
Copy link

POST /api/v1/user/starred

Request body schema (application/json)

Responses

Example command

25.2. listStarredRepos
Copy link

GET /api/v1/user/starred

Query parameters

Responses

Example command

25.3. getLoggedInUser
Copy link

GET /api/v1/user/

Responses

Example command

25.4. deleteStar
Copy link

DELETE /api/v1/user/starred/{repository}

Path parameters

Responses

Example command

25.5. getUserInformation
Copy link

GET /api/v1/users/{username}

Path parameters

Responses

Example command

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Chapter 25. user

25.1. createStarCopy linkLink copied to clipboard!

POST /api/v1/user/starred

Request body schema (application/json)

Responses

Example command

25.2. listStarredReposCopy linkLink copied to clipboard!

GET /api/v1/user/starred

Query parameters

Responses

Example command

25.3. getLoggedInUserCopy linkLink copied to clipboard!

GET /api/v1/user/

Responses

Example command

25.4. deleteStarCopy linkLink copied to clipboard!

DELETE /api/v1/user/starred/{repository}

Path parameters

Responses

Example command

25.5. getUserInformationCopy linkLink copied to clipboard!

GET /api/v1/users/{username}

Path parameters

Responses

Example command

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

25.1. createStar
Copy link

25.2. listStarredRepos
Copy link

25.3. getLoggedInUser
Copy link

25.4. deleteStar
Copy link

25.5. getUserInformation
Copy link