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 are system generated key value metadata for the resource. As an input certain annotations like description can be set
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
Labels are key value data to organize and categorize resources. Providing spectro__tag as value for a label is considered as a kubernetes compliant tag
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 of the resource
uidstring
UID is the unique identifier generated for the resource. This is not an input field for any request.
Populated by the system. Read-only.
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": "2023-12-01T21:31:49.213Z",
        "deletionTimestamp": "2023-12-01T21:31:49.213Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:49.213Z",
        "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": "2023-12-01T21:31:49.213Z"
      }
    }
  ]
}

Loading...