Platform Center
Home / API Documentation / Platform management / Users / Users / View user list

*View user list

Requests

HTTP request

GET /auth/v2/users

Responses

Content-Type application/json

Status code: 200

OK

Sample response

user list

{
   "items": [
     {
       "apiVersion": "auth.alauda.io/v1",
       "kind": "User",
       "metadata": {
         "annotations": {
           "alauda.io/display-name": "user03@alauda.io",
           "projectmembers/creationTimestamp": "2019-06-20 10:04:56 +0800 CST"
         },
         "creationTimestamp": "2019-06-15T08:20:19Z",
         "labels": {
           "auth.alauda.io/user.connector_type": "oidc",
           "auth.alauda.io/user.email": "cbf974556d481e52fdd20908bf88413a",
           "auth.alauda.io/user.status": "active",
           "auth.alauda.io/user.username": "Y5Tr"
         },
         "name": "cbf974556d481e52fdd20908bf88413a",
         "resourceVersion": "7139679",
         "selfLink": "/apis/auth.alauda.io/v1/user03.alauda.io",
         "uid": "69e74d4c-8f46-11e9-8285-fe253f3d19ac"
       },
       "spec": {
         "connector_name": "keycloak",
         "connector_type": "oidc",
         "email": "user03@alauda.io",
         "expired": {
           "begin": "2020-12-08T09:47:56Z",
           "end": "2020-12-08T09:47:56Z"
         },
         "groups": [
           "dev"
         ],
         "is_admin": false,
         "is_disabled": false,
         "last_login_time": "2020-12-08T09:47:56Z",
         "login_failture_times": 0,
         "status": "active",
         "username": "User03"
       },
       "status": {}
     }
   ],
   "kind": "UserList",
   "metadata": {},
   "total": 20
 }

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.expired object set expired time
Path: items[].spec.expired
expired.begin string begin time
Path: items[].spec.expired.begin
expired.end string end time
Path: items[].spec.expired.end
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
kind string See common parameters
metadata object See common parameters

Other status codes