Returns the specified user summary list

GET 
/v1/users/summary

Deprecated, Use Post api - Returns a list of user summaries

Request

Query Parameters

limit int64

Default value: 50

limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.

offset int64

offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.

continue string

continue token to paginate the subsequent data items

Responses

200

OK

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.
]
listmeta object

ListMeta describes metadata for the resource listing

continuestring

Next token for the pagination. Next token is equal to empty string indicates end of result set.

countinteger

Total count of the resources which might change during pagination based on the resources addition or deletion

limitinteger

Number of records feteched

offsetinteger

The next offset for the pagination. Starting index for which next request will be placed.

Example (from schema)

{
  "items": [
    {
      "metadata": {
        "annotations": {},
        "creationTimestamp": "2023-12-01T21:31:49.212Z",
        "deletionTimestamp": "2023-12-01T21:31:49.212Z",
        "labels": {},
        "lastModifiedTimestamp": "2023-12-01T21:31:49.212Z",
        "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.212Z"
      }
    }
  ],
  "listmeta": {
    "continue": "string",
    "count": 0,
    "limit": 0,
    "offset": 0
  }
}

Loading...