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

*View user details

Requests

HTTP request

GET /auth/v1/users/{name}

Fetch user info

Responses

Content-Type application/json

Status code: 200

OK

Sample response

user definition

{
   "metadata": {
     "annotations": {
       "alauda.io/display-name": "user01@alauda.io"
     },
     "labels": {
       "auth.alauda.io/user.connector_type": "oidc",
       "auth.alauda.io/user.email": "cbf974556d481e52fdd20908bf88413a",
       "auth.alauda.io/user.state": "active",
       "auth.alauda.io/user.username": "Y5Tr"
     },
     "name": "cbf974556d481e52fdd20908bf88413a"
   },
   "spec": {
     "account:": "",
     "connector_name": "keycloak",
     "connector_type": "oidc",
     "email": "user01@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,
     "state": "active",
     "username": "User01"
   }
 }

Parameters

Name Type Description
metadata object See common parameters
spec object user spec
Path: spec
spec.connector_name string connector name
Path: spec.connector_name
spec.connector_type string connector type
Path: spec.connector_type
spec.email string email
Path: spec.email
spec.expired object set expired time
Path: spec.expired
expired.begin string begin time
Path: spec.expired.begin
expired.end string end time
Path: spec.expired.end
spec.groups array groups
Path: spec.groups
spec.groups[] string group
Path: spec.groups[]
spec.is_admin boolean check user is admin or not
Path: spec.is_admin
spec.username string username
Path: spec.username

Other status codes