Users

List the users

get

List the users

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/users

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "users": {
    "email": "[email protected]",
    "firstName": "text",
    "lastName": "text",
    "timezone": "text",
    "userType": "text",
    "access": {
      "startDate": "2025-12-22",
      "endDate": "2025-12-22",
      "preventDownload": "no",
      "restrictProjects": "no"
    }
  }
}

Creates a new user assigning them a server generated ID

post

Creates a new user assigning them a server generated ID

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Body

application/json

Refer to the /schemas/user endpoint for the full JSON Schema definition

emailstring · emailRequired

firstNamestringRequired

lastNamestringRequired

timezonestringOptional

userTypestringOptional

Responses

200

successful operation

application/json

400

Invalid status value

application/json

post

/users

HTTPcURLJavaScriptPython

POST /users HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-12-22",
    "endDate": "2025-12-22",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}

{
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-12-22",
    "endDate": "2025-12-22",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}

Get the user

get

Get the user

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/users/{userId}

HTTPcURLJavaScriptPython

GET /users/{userId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-12-22",
    "endDate": "2025-12-22",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}

Update the user

put

Update the user

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

Body

application/json

Refer to the /schemas/user endpoint for the full JSON Schema definition

emailstring · emailRequired

firstNamestringRequired

lastNamestringRequired

timezonestringOptional

userTypestringOptional

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

put

/users/{userId}

HTTPcURLJavaScriptPython

PUT /users/{userId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-12-22",
    "endDate": "2025-12-22",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}

{}

Delete the user

delete

Delete the user

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

delete

/users/{userId}

HTTPcURLJavaScriptPython

DELETE /users/{userId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{}