software-repository-container/api-ref/source/api/updating_image_permissions.rst
proposalbot 4894df0e64 Changes to swr_api-ref from docs/doc-exports#415 (SWR API initial version reuplo
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
2022-11-10 10:13:15 +00:00

95 lines
2.9 KiB
ReStructuredText

:original_name: swr_02_0048.html
.. _swr_02_0048:
Updating Image Permissions
==========================
Function
--------
Update the image operation permissions for certain users.
URI
---
PATCH /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/access
For details about parameters, see :ref:`Table 1 <swr_02_0048__table73271639103420>`.
.. _swr_02_0048__table73271639103420:
.. table:: **Table 1** Parameter description
========== ========= ====== =================
Parameter Mandatory Type Description
========== ========= ====== =================
namespace Yes String Organization name
repository Yes String Image name
========== ========= ====== =================
Request
-------
- Request parameters
.. table:: **Table 2** Request body parameter description
+-----------------+-----------------+-----------------+-------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=====================================+
| user_id | Yes | String | User ID. |
+-----------------+-----------------+-----------------+-------------------------------------+
| user_name | Yes | String | Username. |
+-----------------+-----------------+-----------------+-------------------------------------+
| auth | Yes | Integer | User permission that is configured. |
| | | | |
| | | | - 7: Manage |
| | | | - 3: Write |
| | | | - 1: Read |
+-----------------+-----------------+-----------------+-------------------------------------+
- Example request
.. code-block::
PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
Body:
.. code-block::
[
{
"user_id": "fb3f175c1fd146ab8cdae3272be6107b",
"user_name": "user01",
"auth": 7
}
]
Response
--------
- Response parameters
N/A
- Example response
.. code-block::
{}
Status Code
-----------
=========== =================================================
Status Code Description
=========== =================================================
201 Updated successfully.
400 Request error.
401 Authentication failed.
404 The image or the image permission does not exist.
500 Internal error.
=========== =================================================