Updated on 2024-04-18 GMT+08:00

Querying Organization Permissions

Description

Query organization permissions.

Constraints

None

API Calling

For details, see Calling APIs.

URI

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

Table 1 Path parameter

Parameter

Mandatory

Type

Description

namespace

Yes

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.

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;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 the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

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

Organization creator.

self_auth

UserAuth object

Permissions of the current user.

others_auths

Array of UserAuth objects

Permissions of other users.

Table 4 UserAuth

Parameter

Type

Description

user_id

String

User ID, which needs to be obtained from IAM.

user_name

String

Username, which needs to be obtained from IAM.

auth

Long

User permissions. 7: Manage. 3: Write. 1: Read.

Example Request

GET https://{endpoint}/v2/manage/namespaces/{namespace}/access

Example Response

Status code: 200

Query succeeded.

{
  "id" : 1422,
  "name" : "test",
  "creator_name" : "user01",
  "self_auth" : {
    "user_id" : "3059e6b5562241fda3fa441cca6f228b",
    "user_name" : "user",
    "auth" : 7
  },
  "others_auths" : [ {
    "user_id" : "fb3f175c1fd146ab8cdae3272be6107b",
    "user_name" : "user01",
    "auth" : 7
  } ]
}

Status Codes

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.