Retrieves a list of users summary with provided filter spec

POST 
/v1/users/summary

Retrieves a list of users summary with provided filter spec

Request

application/json

Body

filter

Users filter spec

emailId

object

beginsWithstringnullable

containsstringnullable

eqstringnullable

ignoreCaseboolean

Default value: true

nestringnullable

name

object

beginsWithstringnullable

containsstringnullable

eqstringnullable

ignoreCaseboolean

Default value: true

nestringnullable

sort

undefined[]

Array [

fieldstringnullable

Possible values: [name, creationTimestamp]

orderstring

Possible values: [asc, desc]

Default value: asc

]

Responses

200

An array of users summary items

application/json

Schema

Schema

items

object[]

required

Array [

metadata

object

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

annotations

object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

property name*string

creationTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

deletionTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

labels

object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels

property name*string

lastModifiedTimestampdate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

namestring

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names

uidstring

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

spec

object

emailIdstring

firstNamestring

lastNamestring

projects

object[]

Deprecated.

Array [

namestring

uidstring

]

projectsCountint32

roles

object[]

Array [

namestring

uidstring

]

teams

object[]

Array [

namestring

uidstring

]

status

User status

activationLinkstring

provides the link to activate or reset the user password

isActiveboolean

Specifies if user account is active/disabled

isPasswordResettingboolean

Specifies if user in multi org requested password reset

lastSignIndate-time

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

]

Example (from schema)

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2024-07-02T18:20:59.823Z",
        "deletionTimestamp": "2024-07-02T18:20:59.823Z",
        "labels": {},
        "lastModifiedTimestamp": "2024-07-02T18:20:59.823Z",
        "name": "string",
        "uid": "string"
      },
      "spec": {
        "emailId": "string",
        "firstName": "string",
        "lastName": "string",
        "projects": [
          {
            "name": "string",
            "uid": "string"
          }
        ],
        "projectsCount": 0,
        "roles": [
          {
            "name": "string",
            "uid": "string"
          }
        ],
        "teams": [
          {
            "name": "string",
            "uid": "string"
          }
        ]
      },
      "status": {
        "activationLink": "string",
        "isActive": true,
        "isPasswordResetting": true,
        "lastSignIn": "2024-07-02T18:20:59.823Z"
      }
    }
  ]
}

Loading...