Skip to main content
API docs by Redocly

ESP RainMaker Cloud-to-Cloud APIs (1.0.0)

Download OpenAPI specification:Download

E-mail: esp-rainmaker-admin@espressif.com License: Apache 2.0 Terms of Service

The API definitions for accessing ESP RainMaker from external cloud services. These APIs require AWS Signature v4 (which include access key and secret key) for authorization, provided in the request headers.

Cloud to Cloud based Admin User Management

Cloud to Cloud based Admin User Management

Creates the new user

This API creates a new user in the email-mobile user pool.

Locale:

You can configure the user's preferred language locale for receiving emails and SMS by including the query param: locale in the request.

Note: Emails and SMS will be sent based on the specified locale only for their respective message template types that support custom configuration.
For example 

 locale: "user_locale_value"
  • Reserved value: "rm_non_branded" — This value is designated for internal use and is utilized for sending emails in a specific locale when no default email is configured for the given template type. If this value is provided, it will result in an "Invalid locale" error.
  • If the query param: locale is omitted or left empty, the default locale configured by the admin will be used for emails and SMS.
  • It is case-insensitive and all input locales will be considered in lowercase.
Authorizations:
IAMCredentials
path Parameters
version
required
string
Default: "v1"

API Version (Current supported API Version is 'v1')

query Parameters
locale
string
Default: "no_locale"

It allows the user to specify their preferred language locale for receiving emails and SMS. It is case-insensitive and all input locales will be considered in lowercase.

Request Body schema: application/json
required

Request body for creating new user

user_name
required
string

Valid email address or valid phone number

password
required
string

Password for the user

Responses

Request samples

Content type
application/json
{
  • "user_name": "username@domain.com",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "description": "Success description"
}

Update User Password for user

This API updates password for user in user email mobile user pool.

Authorizations:
IAMCredentials
path Parameters
version
required
string
Default: "v1"

API Version (Current supported API Version is 'v1')

Request Body schema: application/json
required

Request body for updating password of the user

user_name
required
string

Valid email address or valid phone number

password
required
string

Password for the user

Responses

Request samples

Content type
application/json
{
  • "user_name": "user@domain.com",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "description": "Success description"
}

Delete User

This API deletes user from email mobile user pool.

Authorizations:
IAMCredentials
path Parameters
version
required
string
Default: "v1"

API Version (Current supported API Version is 'v1')

Request Body schema: application/json
required

Request body for deleting the user

user_name
required
string

Valid email address or valid phone number

Responses

Request samples

Content type
application/json
{
  • "user_name": "user@domain.com"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "description": "Success description"
}