User types

List the user types

get

List the user types

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Responses

200

successful operation

application/json

400

Invalid status value

application/json

get

/user-types

HTTPcURLJavaScriptPython

GET /user-types HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{
  "userTypes": {
    "id": "text",
    "name": "text",
    "application": "ams"
  }
}

Creates a new user type assigning them a server generated ID

post

Creates a new user type assigning them a server generated ID

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Body

application/json

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

idstringRead-onlyOptional

namestringRequired

applicationstring · enumRequiredPossible values:

Responses

200

successful operation

application/json

400

Invalid status value

application/json

post

/user-types

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "application": "ams"
}

{
  "id": "text",
  "name": "text",
  "application": "ams"
}

Get the user type

get

Get the user type

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userTypeIdstringRequired

The ID of the user type

Body

application/json

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

idstringRead-onlyOptional

namestringRequired

applicationstring · enumRequiredPossible values:

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

get

/user-types/{userTypeId}

HTTPcURLJavaScriptPython

GET /user-types/{userTypeId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "application": "ams"
}

{}

Update the user type

put

Update the user type

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userTypeIdstringRequired

The ID of the user type

Body

application/json

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

idstringRead-onlyOptional

namestringRequired

applicationstring · enumRequiredPossible values:

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

put

/user-types/{userTypeId}

HTTPcURLJavaScriptPython

PUT /user-types/{userTypeId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "application": "ams"
}

{}

Delete the user type

delete

Delete the user type

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userTypeIdstringRequired

The ID of the user type

Responses

200

successful operation

application/json

Responseobject

400

Invalid status value

application/json

delete

/user-types/{userTypeId}

HTTPcURLJavaScriptPython

DELETE /user-types/{userTypeId} HTTP/1.1
Host: api.ecosuite.io/
Authorization: YOUR_API_KEY
Accept: */*

{}