ESP RainMaker Cloud-to-Cloud APIs (1.0.0)
Download OpenAPI specification:Download
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.
Creates the new user
This API creates a new user in user email mobile user pool.
Authorizations:
path Parameters
version required | string Default: "v1" API Version (Current supported API Version is 'v1') |
Request Body schema: application/jsonrequired
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
- Payload
{- "user_name": "username@domain.com",
- "password": "password"
}
Response samples
- 201
- 400
- 500
{- "status": "success",
- "description": "Success description"
}
Update User Password for user
This API updates password for user in user email mobile user pool.
Authorizations:
path Parameters
version required | string Default: "v1" API Version (Current supported API Version is 'v1') |
Request Body schema: application/jsonrequired
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
- Payload
{- "user_name": "user@domain.com",
- "password": "password"
}
Response samples
- 200
- 400
- 404
- 500
{- "status": "success",
- "description": "Success description"
}
Delete User
This API deletes user from email mobile user pool.
Authorizations:
path Parameters
version required | string Default: "v1" API Version (Current supported API Version is 'v1') |
Request Body schema: application/jsonrequired
Request body for deleting the user
user_name required | string Valid email address or valid phone number |
Responses
Request samples
- Payload
{- "user_name": "user@domain.com"
}
Response samples
- 200
- 400
- 500
{- "status": "success",
- "description": "Success description"
}