Users

• Get a list of filtered users

• Update a user with its ID

• Delete a user with its ID

• Get a user entity

• Create a user entity

• Batch create user entities

Get a user entity

get

/public/v1/users/{id}

Path parameters

idstringrequired

Unique id of user to update

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.configure8.io/public/v1/users/{id}'

200

400

401

403

404

200

{
  "id": "text",
  "email": "text",
  "orgId": "text",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "photoUrl": "text",
  "acceptedTermsOfServiceAndPrivacyPolicyAt": "2025-02-21T18:10:40.806Z",
  "lastChangedBy": "text",
  "lastLoginAt": "2025-02-21T18:10:40.806Z",
  "provisioned": true,
  "status": "INVITED",
  "role": "USER"
}

Create a user entity

post

/public/v1/users

Body

emailstringrequired

User email

passwordstring · min: 8 · max: 64required

User password

firstNamestring · min: 1 · max: 128required

User first name

lastNamestring · min: 1 · max: 128required

User last name

rolestring · enumrequired

User role

Options: USER, ADMIN

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/users' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text","password":"text","firstName":"text","lastName":"text","role":"USER"}'

201

400

401

403

409

500

201

{
  "id": "text",
  "email": "text",
  "orgId": "text",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "photoUrl": "text",
  "acceptedTermsOfServiceAndPrivacyPolicyAt": "2025-02-21T18:10:40.806Z",
  "lastChangedBy": "text",
  "lastLoginAt": "2025-02-21T18:10:40.806Z",
  "provisioned": true,
  "status": "INVITED",
  "role": "USER"
}

batch create user entities

post

/public/v1/users/batch

Body

emailstringrequired

User email

passwordstring · min: 8 · max: 64required

User password

firstNamestring · min: 1 · max: 128required

User first name

lastNamestring · min: 1 · max: 128required

User last name

rolestring · enumrequired

User role

Options: USER, ADMIN

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/users/batch' \
  --header 'Content-Type: application/json' \
  --data '[{"email":"text","password":"text","firstName":"text","lastName":"text","role":"USER"}]'

200

400

401

403

409

500

200

{
  "success": 1,
  "failures": 1,
  "items": [
    {
      "id": "text",
      "email": "text",
      "orgId": "text",
      "firstName": "text",
      "lastName": "text",
      "displayName": "text",
      "photoUrl": "text",
      "acceptedTermsOfServiceAndPrivacyPolicyAt": "2025-02-21T18:10:40.806Z",
      "lastChangedBy": "text",
      "lastLoginAt": "2025-02-21T18:10:40.806Z",
      "provisioned": true,
      "status": "INVITED",
      "role": "USER"
    }
  ],
  "failed": [
    {
      "email": "text",
      "password": "text",
      "firstName": "text",
      "lastName": "text",
      "role": "USER"
    }
  ]
}

Return list of users based on the given filters

get

/public/v1/users

Query parameters

searchTermsstring

Search term to filter users on that basis

pageNumbernumber

Page number for getting results

pageSizenumber · default: 20

How many users should be included in one page

sortPropertystring · enum · default: lastName

Sort the result based on this property

Options: id, firstName, lastName, email, displayName, orgId, status, role, photoUrl, acceptedTermsOfServiceAndPrivacyPolicyAt, createdAt, updatedAt, lastChangedBy, lastLoginAt

sortOrderstring · enum · default: ASC

Sort order

Options: ASC, DESC

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.configure8.io/public/v1/users'

200

200

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

Update a user entity

patch

/public/v1/users/{id}

Path parameters

idstringrequired

Unique id of user to update

Body

firstNamestring

User first name

lastNamestring

User last name

displayNamestring

User display name

photoUrlstring

User avatar url

statusstring · enum

User status

Options: INVITED, UNVERIFIED, ACTIVE, DISABLED

rolestring · enum

User role

Options: USER, ADMIN

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app.configure8.io/public/v1/users/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"INVITED","role":"USER"}'

200

401

403

404

409

200

{
  "id": "text",
  "email": "text",
  "orgId": "text",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "photoUrl": "text",
  "acceptedTermsOfServiceAndPrivacyPolicyAt": "2025-02-21T18:10:40.806Z",
  "lastChangedBy": "text",
  "lastLoginAt": "2025-02-21T18:10:40.806Z",
  "provisioned": true,
  "status": "INVITED",
  "role": "USER"
}

Delete a user entity

delete

/public/v1/users/{id}

Path parameters

idstringrequired

Unique id of user to delete

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.configure8.io/public/v1/users/{id}'

204

401

403

404

409

204

No body