Querying Image Permissions¶

Function¶

Query image permissions.

Constraints¶

None

URI¶

GET /v2/manage/namespaces/{namespace}/repos/{repository}/access

For details about parameters, see Table 1.

**Table 1** Parameter description¶
Parameter	Mandatory	Type	Description
namespace	Yes	String	Organization name
repository	Yes	String	Image name

Request¶

Request parameters

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format). The value can be application/json or charset=utf-8 application/json. The default value is application/json.
X-Auth-Token	Yes	String	User token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Example request

GET https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access

Response¶

Response parameters

**Table 3** Response body parameter description¶
Parameter	Type	Description
id	Integer	Permission ID.
name	String	Image name.
self_auth	Object	Permissions of the current user.
others_auths	Array of objects	Permissions of other users.

**Table 4** self_auth parameter description¶
Parameter	Type	Description
user_id	String	User ID
user_name	String	Username
auth	Integer	User permission 7: Manage 3: Write 1: Read

**Table 5** others_auths parameter description¶
Parameter	Type	Description
user_id	String	User ID
user_name	String	Username
auth	Integer	User permission 7: Manage 3: Write 1: Read

Example response

{
    "id": 1422,
    "name": "busybox",
    "self_auth": {
        "user_id": "3059e6b5562241fda3fa441cca6f228b",
        "user_name": "admin",
        "auth": 7
    },
    "others_auths": [
        {
            "user_id": "fb3f175c1fd146ab8cdae3272be6107b",
            "user_name": "user",
            "auth": 1
        }
    ]
}

Status Code¶

Status Code	Description
200	Query succeeded.
400	Request error.
401	Authentication failed.
404	The image or the image permission does not exist.
500	Internal error.

Error Codes¶

For details, see Error Codes.

last updated: 2024-11-14 08:39 UTC - commit: bfa3c32faf53bd2546070a262daff2ecfb4a7227