Skip to main content

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

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

An array of users summary items

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.

  • ]

Loading...