Users

• Get a list of filtered users

• Update a user with its ID

• Delete a user with its ID

Return list of users based on the given filters

GEThttps://app.configure8.io/public/v1/users

Query parameters

Response

200

Body

application/json

items*array of User (object)

List of users

totalFound*number

Total users found by this endpoint call

pageSize*number

Maximum users in one paginated response

pageNumber*number

Requested page, note that it starts with 0

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {}
  ],
  "totalFound": 0,
  "pageSize": 0,
  "pageNumber": 0
}

Update a user entity

PATCHhttps://app.configure8.io/public/v1/users/{id}

Path parameters

id*string

Unique id of user to update

Body

application/json

firstNamestring

User first name

lastNamestring

User last name

displayNamestring

User display name

photoUrlstring

User avatar url

statusenum

User status

INVITEDUNVERIFIEDACTIVEDISABLED

roleenum

User role

USERADMIN

Response

200401403404409

Body

application/json

id*string

User id

email*string

User email

orgId*string

User organization id

firstNamestring

User first name

lastNamestring

User last name

displayNamestring

User display name

status*enum

User status

INVITEDUNVERIFIEDACTIVEDISABLED

role*enum

User role

USERADMIN

photoUrlstring

User avatar url

acceptedTermsOfServiceAndPrivacyPolicyAtstring (date-time)

Identifier for when user accepted terms of service and privacy policy

lastChangedBystring

Who last changed this user info

lastLoginAtstring (date-time)

Last user login date

provisionedboolean

Indificates if user created with SCIM

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/users/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "email": "text",
  "orgId": "text",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "status": "INVITED",
  "role": "USER",
  "photoUrl": "text",
  "acceptedTermsOfServiceAndPrivacyPolicyAt": "2024-11-21T06:28:46.349Z",
  "lastChangedBy": "text",
  "lastLoginAt": "2024-11-21T06:28:46.349Z",
  "provisioned": false
}

Delete a user entity

DELETEhttps://app.configure8.io/public/v1/users/{id}

Path parameters

id*string

Unique id of user to delete

Response

204401403404409

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/users/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();