Get users

This endpoint can retrieve users from Lifecycle or you can search for users using parameters

Query Parameters

• query object

  Allows for pagination and sorting using the deepObject notation.

  
  

  resource?query[limit]=50&query[offset]=0&query[order]=label

  
  

  Parameter	Description	Default
  limit	Limits the number of results returned	100
  offset	Returns the results starting at the value provided	0
  order	Allows you to determine the order in which the data is returned (not available on profile attributes)	id

  Example: query[limit]=100&query[offset]=50&query[order]=created_at
• name string

  object name for filtering

  Example: objectname
• login string

  The user login to search by

  Example: myuser
• title string

  The user title to search by

  Example: usertitle
• status string

  Possible values: [Active, Inactive, On Leave, Terminated]

  status value for filtering

  Example: Active
• email email

  The user email to search by

  Example: test@sailpoint.com
• metadata boolean

  Returns batching metadata in the response

  Example: true

Responses

• 200
• 400
• 500

---

Expected response to a valid request

application/json

• Schema
• Example (from schema)

---

Schema

• users object[]

  id uuid

  The id

  uid string

  Possible values: >= 32 characters and <= 32 characters

  The uid

  name string

  The name

  email email

  The email

  type string

  Possible values: [NeprofileUser, NeaccessUser]

  Default value: NeprofileUser

  The type

  title string

  The title

  status string

  Possible values: [Active, Disabled]

  The status

  login string

  The login

  last_login date-time

  The last login time

  cookies_accepted_at date-time

  The time the cookies were accepted at

  preferred_language string

  The preferred language

• _metadata object

  limit int32

  The limit

  offset int32

  The offset

  total int32

  The total

  next string

  The link to the next page of data

  previous string

  The link to the previous page of data

{
  "users": [
    {
      "id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "name": "bob",
      "email": "example@sailpoint.com",
      "type": "NeprofileUser",
      "title": "mytitle",
      "status": "Active",
      "login": "bob",
      "last_login": "2023-05-01T09:12:28Z",
      "cookies_accepted_at": "2023-05-01T09:12:28Z",
      "preferred_language": "en-US"
    }
  ],
  "_metadata": {
    "limit": 50,
    "offset": 100,
    "total": 10000,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

Bad Request - unable to complete.

application/json

• Schema
• Example (from schema)

---

Schema

oneOf
• MOD1
• MOD2
---
error
error
errors

{
  "error": "Invalid JSON syntax. Please check your syntax and try again."
}

Internal Server Error - returned on unhandled exceptions.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

{
  "error": "Sorry something went wrong"
}

Loading...