Querying Organizations

Query organizations.

None

For details, see Calling APIs.

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.

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 and multiple consecutive hyphens are allowed.
filter	No	String	Set this parameter to 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.)

**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. Default value: application/json
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

By default, all organizations will be returned.

Status code: 200

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

**Table 4** ShowNamespace
Parameter	Type	Description
id	Integer	id
name	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.
creator_name	String	IAM username.
auth	Integer	User permissions. 7: manage. 3: edit. 1: read.

GET https://{endpoint}/v2/manage/namespaces?filter=namespace::{namespace}

Status code: 200

The list of organizations has been obtained.

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

Status Code	Description
200	Organization list obtained.
400	Request error.
401	Authentication failed.
404	The organization was not found.
500	Internal error.

For details, see Error Codes.

Parent topic: Organization Management

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel