Chapter 16. permission
Manage repository permissions.
16.1. getUserTransitivePermission
Get the fetch the permission for the specified user.
16.1.1. GET /api/v1/repository/{repository}/permissions/user/{username}/transitive
Authorizations: oauth2_implicit (repo:admin)
16.1.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | username required | The username of the user to which the permissions apply | string |
| path | repository required | The full path of the repository. e.g. namespace/name | string |
16.1.3. Responses
16.1.4. Example command
$ curl -X GET \
-H "Authorization: Bearer <access_token>" \
"https://quay-server.example.com/api/v1/repository/<repository_path>/permissions/user/<username>/transitive"16.2. getUserPermissions
Get the permission for the specified user.
16.2.1. GET /api/v1/repository/{repository}/permissions/user/{username}
Authorizations: oauth2_implicit (repo:admin)
16.2.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | username required | The username of the user to which the permission applies | string |
| path | repository required | The full path of the repository. e.g. namespace/name | string |
16.2.3. Responses
16.2.4. Example command
$ curl -X GET \
-H "Authorization: Bearer <access_token>" \
"https://quay-server.example.com/api/v1/repository/<repository_path>/permissions/user/<username>"16.3. changeUserPermissions
Update the perimssions for an existing repository.
16.3.1. PUT /api/v1/repository/{repository}/permissions/user/{username}
Authorizations: oauth2_implicit (repo:admin)
16.3.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | username required | The username of the user to which the permission applies | string |
| path | repository required | The full path of the repository. e.g. namespace/name | string |
16.3.3. Request body schema (application/json)
Description of a user permission.
| Name | Description | Schema |
|---|---|---|
| role required | Role to use for the user | string |
16.3.4. Responses
16.3.5. Example command
$ curl -X PUT \
-H "Authorization: Bearer <bearer_token>" \
-H "Content-Type: application/json" \
-d '{"role": "admin"}' \
https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>16.4. deleteUserPermissions
Delete the permission for the user.
16.4.1. DELETE /api/v1/repository/{repository}/permissions/user/{username}
Authorizations: oauth2_implicit (repo:admin)
16.4.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | username required | The username of the user to which the permission applies | string |
| path | repository required | The full path of the repository. e.g. namespace/name | string |
16.4.3. Responses
16.4.4. Example command
$ curl -X DELETE \
-H "Authorization: Bearer <bearer_token>" \
-H "Accept: application/json" \
https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>16.5. getTeamPermissions
Fetch the permission for the specified team.
16.5.1. GET /api/v1/repository/{repository}/permissions/team/{teamname}
Authorizations: oauth2_implicit (repo:admin)
16.5.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
| path | teamname required | The name of the team to which the permission applies | string |
16.5.3. Responses
16.5.4. Example command
$ curl -X GET \
-H "Authorization: Bearer <access_token>" \
"https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/team/<teamname>"16.6. changeTeamPermissions
Update the existing team permission.
16.6.1. PUT /api/v1/repository/{repository}/permissions/team/{teamname}
Authorizations: oauth2_implicit (repo:admin)
16.6.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
| path | teamname required | The name of the team to which the permission applies | string |
16.6.3. Request body schema (application/json)
Description of a team permission.
| Name | Description | Schema |
|---|---|---|
| role required | Role to use for the team | string |
16.6.4. Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Successful invocation | |
| 400 | Bad Request | |
| 401 | Session required | |
| 403 | Unauthorized access | |
| 404 | Not found |
$ curl -X PUT \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"role": "<role>"}' \
"https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/team/<teamname>"16.7. deleteTeamPermissions
Delete the permission for the specified team.
16.7.1. DELETE /api/v1/repository/{repository}/permissions/team/{teamname}
Authorizations: oauth2_implicit (repo:admin)
16.7.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
| path | teamname required | The name of the team to which the permission applies | string |
16.7.3. Responses
16.7.4. Example command
$ curl -X DELETE \
-H "Authorization: Bearer <access_token>" \
"https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/team/<teamname>"16.8. listRepoTeamPermissions
List all team permission.
16.8.1. GET /api/v1/repository/{repository}/permissions/team/
Authorizations: oauth2_implicit (repo:admin)
16.8.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
16.8.3. Responses
16.8.4. Example command
$ curl -X GET \
-H "Authorization: Bearer <access_token>" \
"https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/team/"16.9. listRepoUserPermissions
List all user permissions.
16.9.1. GET /api/v1/repository/{repository}/permissions/user/
Authorizations: oauth2_implicit (repo:admin)
16.9.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
16.9.3. Responses
16.9.4. Example command
$ curl -X GET \
-H "Authorization: Bearer <bearer_token>" \
-H "Accept: application/json" \
https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>/
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}