Querying Organizations¶
Description¶
Query organizations.
Constraints¶
None
URI¶
GET /v2/manage/namespaces
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.)  | 
Request 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.  | 
Note
By default, all organizations will be returned.
Response Parameters¶
Status code: 200
Parameter  | Type  | Description  | 
|---|---|---|
namespaces  | Array of ShowNamespace objects  | Organization list.  | 
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.  | 
Example Request¶
GET https://{endpoint}/v2/manage/namespaces?filter=namespace::{namespace}
Example Response¶
Status code: 200
The list of organizations has been obtained.
{
  "namespaces" : [ {
    "id" : 1422,
    "name" : "group",
    "creator_name" : "username",
    "auth" : 7
  } ]
}
Status Codes¶
Status Code  | Description  | 
|---|---|
200  | Organization list obtained.  | 
400  | Request error.  | 
401  | Authentication failed.  | 
404  | The organization was not found.  | 
500  | Internal error.  | 
Error Codes¶
For details, see Error Codes.