Listing the Users Who Have Been Assigned Passes (Excluding Inactive Users)
Function
This API is used to list the users who have been assigned passes (excluding inactive users).
URI
GET /v1/{project_id}/quota-users
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For how to obtain the project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
account_name |
No |
String |
Username (fuzzy search). |
sys_role |
No |
String |
System-defined roles. The options include:
|
type |
No |
String |
Role type. The value can be IAM or SELF-BUILT. |
sort_key |
No |
String |
Sorting field. The options include effectiveTime and accountName. |
sort_dir |
No |
String |
Sorting mode. The options are desc and asc. |
offset |
No |
Integer |
Number of pages. The default value is 0. |
limit |
No |
Integer |
Number of data records on each page. The default value is 10. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total data volume. |
page_data |
Array of Table 5 objects |
Data. |
Parameter |
Type |
Description |
---|---|---|
user_id |
String |
User ID. |
account_name |
String |
Username. |
user_type |
String |
User type. The options are IAM, SELF-BUILT, and DEFAULT. |
sys_role |
Integer |
User role. The options include:
Enumerated values:
|
effective_time |
Long |
Effective timestamp. |
Example Request
GET https://{endpoint}/v1/{project_id}/quota-users?sort_key=accountName&sort_dir=asc&limit=10&offset=0&account_name=&sys_role=1
Example Response
None
Status Codes
Status Code |
Description |
---|---|
200 |
Passes are successfully listed. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot