Querying the List of Organizations
Function
Query the list of organizations.
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. |
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
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
Parameter | Type | Description |
---|---|---|
namespaces | Array of objects | Organization list |
Parameter | Type | Description |
---|---|---|
ID | Integer | Organization ID |
name | String | Organization name |
creator_name | String | IAM username |
auth | Integer | User permission
|
Example Request
GET https://{Endpoint}/v2/manage/namespaces?filter=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.
- Function
- URI
- Request Parameters
- Response Parameters
- Example Request
- Example Response
- Status Code
- Error Codes