Notifications

List the notifications for a user

get

Get the users MFA status

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

Responses

200

successful operation

application/json

notificationsobject[]Optional

Refer to the /schemas/notification endpoint for the JSON Schema definition

400

Invalid status value

application/json

get

/users/{userId}/notifications

HTTPcURLJavaScriptPython

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

{
  "notifications": [
    {}
  ]
}

Creates a new user notification

post

Creates a new user notification

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

Body

application/json

objectOptional

Refer to the /schemas/notification endpoint for the JSON Schema definition

Responses

200

successful operation

application/json

notificationobjectOptional

Refer to the /schemas/notification endpoint for the JSON Schema definition

400

Invalid status value

application/json

post

/users/{userId}/notifications

HTTPcURLJavaScriptPython

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

{}

{
  "notification": {}
}

Updates a new user notification

put

Updates a new user notification

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

notificationIdstringRequired

The ID of the notification

Body

application/json

objectOptional

Refer to the /schemas/notification endpoint for the JSON Schema definition

Responses

200

successful operation

application/json

notificationobjectOptional

Refer to the /schemas/notification endpoint for the JSON Schema definition

400

Invalid status value

application/json

put

/users/{userId}/notifications/{notificationId}

HTTPcURLJavaScriptPython

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

{}

{
  "notification": {}
}

Deletes a new user notification

delete

Deletes a new user notification

Authorizations

ecogy-auth-cognito-dev

AuthorizationstringRequired

Path parameters

userIdstringRequired

The ID of the user

notificationIdstringRequired

The ID of the notification

Responses

200

successful operation

application/json

objectOptional

400

Invalid status value

application/json

delete

/users/{userId}/notifications/{notificationId}

HTTPcURLJavaScriptPython

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

{}