#User [v1]

#/auth/v1/users

#post create user

#Request Body

User

#Response

• 201 User: OK

#/auth/v1/users/{name}

#get Fetch user info

#Parameters

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

#Response

• 200 User: OK

#delete delete specific users

#Parameters

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

#Response

• 204 : OK

#patch modify user's password and display-name

#Parameters

• Authorization (in header): string

  Given Bearer token will use this as authorization for the API

#Response

• 201 User: OK

#User

• apiVersion: string

  APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

• kind: string

  Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

• metadata: ObjectMeta

  ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

• spec: UserSpec
• status: UserStatus

#UserSpec

• account: string
• connector_id: string
• connector_name: string
• connector_type: string
• continuity_errors: integer
• email: string
• expired: Expired
• extra: object
• groups: []string
• ids: []UserId
• is_admin: boolean
• is_disabled: boolean
• last_login_time: string
• mail: string
• mobile: string
• old_password: string
• password: string
• state: string
• username: string
• valid: boolean
• webhookType: string
• webhookUrl: string

#Expired

• begin: string
• end: string

#UserId

• id: string
• type: string

#UserStatus

#Related APIs

• Pubkey [v1]
• AccessToken [v1]

#API usage

These APIs do not use /kubernetes/{cluster} as a path prefix.

#List users

GET /auth/v1/users

Common list query parameters:

#Get a specific user

GET /auth/v1/users/{name}

{name} is the user resource name (metadata.name).

#Request examples

List users:

curl -H "Authorization: Bearer ${TOKEN}" \
  "${APISERVER}/auth/v1/users?limit=20&page=1"

Query a user by username:

curl -H "Authorization: Bearer ${TOKEN}" \
  "${APISERVER}/auth/v1/users?filterBy=username,${USERNAME}&limit=20&page=1"

Get a specific user:

curl -H "Authorization: Bearer ${TOKEN}" \
  "${APISERVER}/auth/v1/users/${USER_NAME}"

#Response examples

User list response snippet:

{
  "kind": "UserList",
  "total": 1,
  "items": [
    {
      "metadata": {
        "name": "jane"
      },
      "spec": {
        "username": "jane",
        "email": "jane@example.com",
        "is_admin": false
      }
    }
  ]
}

User detail response snippet:

{
  "kind": "User",
  "metadata": {
    "name": "jane"
  },
  "spec": {
    "username": "jane",
    "email": "jane@example.com",
    "connector_type": "ldap",
    "is_admin": false
  }
}