User types

List the user types

get

List the user types

Authorizations
Responses
200

successful operation

application/json
get
/user-types
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
Body

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
post
/user-types
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
Path parameters
userTypeIdstringRequired

The ID of the user type

Body

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
get
/user-types/{userTypeId}
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
Path parameters
userTypeIdstringRequired

The ID of the user type

Body

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
put
/user-types/{userTypeId}
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
Path parameters
userTypeIdstringRequired

The ID of the user type

Responses
200

successful operation

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

{}
PreviousResendNextAudit