Dong, Qiu Jian f5c28c856a SWR API update 20241012

Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>

2024-10-18 07:19:46 +00:00

14 KiB

Raw Blame History

Querying the List of Organizations

Function

Query the list of organizations.

URI

GET /v2/manage/namespaces

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
namespace	No	String	Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.
filter	No	String	Enter *namespace::{namespace}\|mode::{mode}. {namespace}* indicates the organization name. If {mode} is not set, the list of authorized organizations is displayed. If {mode} is set to visible, the list of visible organizations is displayed. (Some organizations can be viewed by the repository, but cannot by the organization.)

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.

By default, all organizations will be returned.

Response Parameters

**Table 3** Response body parameter description
Parameter	Type	Description
namespaces	Array of objects	Organization list

**Table 4** namespaces parameter description
Parameter	Type	Description
ID	Integer	Organization ID
name	String	Organization name
creator_name	String	IAM username
auth	Integer	User permission 7: Manage 3: Write 1: Read

Example Request

GET https://{Endpoint}/v2/manage/namespaces?namespace=group

Example Response

Status code: 200

The list of organizations is returned successfully.

{
    "namespaces": [
        {
            "id": 1343008,
            "name": "group",
            "creator_name": "username",
            "auth": 7
        }
    ]
}

Status Code

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

Error Codes

For details, see Error Codes.

Parent topic: Organization Management

14 KiB Raw Blame History