Platform Center
Home / API Documentation / Platform management / Users / Users / View user list (soon to be scrapped)

*View user list (soon to be scrapped)

Tip: This interface will be deprecated soon, but it will work fine until it is deprecated. It is recommended that you use the optimized interface GET /auth/v2/users, which supports filtering of users by status on top of GET /auth/v1/users and has better performance.

Requests

HTTP request

GET /auth/v1/users

Fetch users

Responses

Content-Type application/json

Status code: 200

OK

Sample response

user list

{
   "items": [
     {
       "apiVersion": "auth.alauda.io/v1",
       "kind": "User",
       "metadata": {
         "annotations": {
           "cpaas.io/display-name": "areslwrgs-bot"
         },
         "creationTimestamp": "2021-06-21T08:59:42Z",
         "generation": 1,
         "labels": {
           "auth.cpaas.io/user.connector_id": "local",
           "auth.cpaas.io/user.connector_type": "local",
           "auth.cpaas.io/user.email": "84a4eeac2a6efeba8b4a3c0fd044069b",
           "auth.cpaas.io/user.state": "active",
           "auth.cpaas.io/user.username": "",
           "auth.cpaas.io/user.valid": "true"
         },
         "name": "84a4eeac2a6efeba8b4a3c0fd044069b",
         "resourceVersion": "202851",
         "selfLink": "/apis/auth.alauda.io/v1/users/84a4eeac2a6efeba8b4a3c0fd044069b",
         "uid": "7bae9bd0-7d6e-4c32-87b9-163cc17c0e09"
       },
       "spec": {
         "connector_name": "local",
         "connector_type": "local",
         "email": "areslwrgs-bot@acp.io",
         "groups": [
           "ungrouped"
         ],
         "is_admin": false,
         "mail": "areslwrgs-bot@acp.io",
         "state": "active",
         "username": "areslwrgs-bot",
         "valid": true
       }
     },
     {
       "apiVersion": "auth.alauda.io/v1",
       "kind": "User",
       "metadata": {
         "annotations": {
           "cpaas.io/display-name": "admin"
         },
         "creationTimestamp": "2021-06-21T05:27:22Z",
         "generation": 59,
         "labels": {
           "auth.cpaas.io/user.connector_id": "local",
           "auth.cpaas.io/user.connector_type": "local",
           "auth.cpaas.io/user.email": "8afe307d054f1e96ce2e3d10aa374162",
           "auth.cpaas.io/user.state": "active",
           "auth.cpaas.io/user.username": "",
           "auth.cpaas.io/user.valid": "true"
         },
         "name": "8afe307d054f1e96ce2e3d10aa374162",
         "resourceVersion": "10602022",
         "selfLink": "/apis/auth.alauda.io/v1/users/8afe307d054f1e96ce2e3d10aa374162",
         "uid": "9c64cb40-022d-484a-ae34-8d43b7fd2ccd"
       },
       "spec": {
         "connector_name": "local",
         "connector_type": "local",
         "email": "admin@cpaas.io",
         "groups": [
           "ungrouped"
         ],
         "is_admin": true,
         "last_login_time": "2021-06-30T08:38:32Z",
         "mail": "admin@cpaas.io",
         "state": "active",
         "username": "admin",
         "valid": true
       }
     }
   ],
   "kind": "UserList",
   "metadata": {},
   "total": 2
 }

Parameters

Name Type Description
items array
Path: items
items[] object user definition
Path: items[]
items[].apiVersion string See common parameters
items[].kind string See common parameters
items[].metadata object See common parameters
items[].spec object user spec
Path: items[].spec
spec.connector_name string connector name
Path: items[].spec.connector_name
spec.connector_type string connector type
Path: items[].spec.connector_type
spec.email string email
Path: items[].spec.email
spec.groups array groups
Path: items[].spec.groups
spec.groups[] string group
Path: items[].spec.groups[]
spec.is_admin boolean check user is admin or not
Path: items[].spec.is_admin
spec.username string username
Path: items[].spec.username
spec.valid boolean describe user is valid or not
Path: items[].spec.valid
kind string See common parameters
metadata object See common parameters

Other status codes