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

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

Path parameters

id*string

Unique id of user to update

Response

200400401403404

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: 'GET',
    headers: {},
});
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-12-21T12:13:28.000Z",
  "lastChangedBy": "text",
  "lastLoginAt": "2024-12-21T12:13:28.000Z",
  "provisioned": false
}

Create a user entity

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

Body

application/json

email*string

User email

password*string

User password

firstName*string

User first name

lastName*string

User last name

role*enum

User role

USERADMIN

Response

201400401403409500

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', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "password": "text",
      "firstName": "text",
      "lastName": "text",
      "role": "USER"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "email": "text",
  "orgId": "text",
  "firstName": "text",
  "lastName": "text",
  "displayName": "text",
  "status": "INVITED",
  "role": "USER",
  "photoUrl": "text",
  "acceptedTermsOfServiceAndPrivacyPolicyAt": "2024-12-21T12:13:28.000Z",
  "lastChangedBy": "text",
  "lastLoginAt": "2024-12-21T12:13:28.000Z",
  "provisioned": false
}

batch create user entities

POSThttps://app.configure8.io/public/v1/users/batch

Body

application/json

Array of user entities to create. Max size is 50.

email*string

User email

password*string

User password

firstName*string

User first name

lastName*string

User last name

role*enum

User role

USERADMIN

Response

200400401403409500

Body

application/json

success*number

Number of successfully saved entities

failures*number

Number of entities that failed saving

items*array of UserDto (object)

Created users

failed*array of CreateUserDto (object)

Failed users

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/users/batch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "email": "text",
        "password": "text",
        "firstName": "text",
        "lastName": "text",
        "role": "USER"
      }
    ]),
});
const data = await response.json();

Response

200

{
  "success": 0,
  "failures": 0,
  "items": [
    {
      "id": "text",
      "email": "text",
      "orgId": "text",
      "firstName": "text",
      "lastName": "text",
      "displayName": "text",
      "status": "INVITED",
      "role": "USER",
      "photoUrl": "text",
      "acceptedTermsOfServiceAndPrivacyPolicyAt": "2024-12-21T12:13:28.000Z",
      "lastChangedBy": "text",
      "lastLoginAt": "2024-12-21T12:13:28.000Z",
      "provisioned": false
    }
  ],
  "failed": [
    {
      "email": "text",
      "password": "text",
      "firstName": "text",
      "lastName": "text",
      "role": "USER"
    }
  ]
}

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-12-21T12:13:27.831Z",
  "lastChangedBy": "text",
  "lastLoginAt": "2024-12-21T12:13:27.831Z",
  "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();