Notifications

PreviousMfa NextResend

List the notifications for a user

Get the users MFA status

get

/users/{userId}/notifications

Authorizations

Path parameters

userIdstringrequired

The ID of the user

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.ecosuite.io//users/{userId}/notifications' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{
  "notifications": [
    {}
  ]
}

successful operation

Creates a new user notification

post

/users/{userId}/notifications

Authorizations

Path parameters

userIdstringrequired

The ID of the user

Body

object

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.ecosuite.io//users/{userId}/notifications' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

400

{
  "notification": {}
}

successful operation

Updates a new user notification

put

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

Authorizations

Path parameters

userIdstringrequired

The ID of the user

notificationIdstringrequired

The ID of the notification

Body

object

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.ecosuite.io//users/{userId}/notifications/{notificationId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json'

200

400

{
  "notification": {}
}

successful operation

Deletes a new user notification

delete

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

Authorizations

Path parameters

userIdstringrequired

The ID of the user

notificationIdstringrequired

The ID of the notification

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.ecosuite.io//users/{userId}/notifications/{notificationId}' \
  --header 'Authorization: YOUR_API_KEY'

200

400

{}

successful operation