IDaaS Open Platform
Customer Identity (CIAM)

Interface Specification

# Event Notification Interface

In Bamboo Cloud IDaaS, the WebHook callback interface uses POST as the request method, UTF-8 for data encoding, and JSON for data format.

When an event is triggered, Bamboo Cloud IDaaS pushes the user ID to the callback address provided by the application system.

# 1. Request Specification

POST

# 2. Request Headers

Parameter Name Chinese Name Required Example Value Description
Authorization Authorization Yes String Format: Bearer {token}
Content-Type Content Type Yes String Fixed value: application/json; charset=utf-8

# 3. Request Body

Request Body Example

  1. Create User
{ "nonce":"123456", "timestamp":1783610513, "event":"USER_CREATE", "data":"1ojvw2WPvW7LijxS8UvP+rXpPbcLGOmIBNbWetRg7IP0vdhkl", "sign":"111108bb8e6dbce3c9671d6fdb69d15066227608" }
1
  1. Update User Mobile Number
{ "nonce":"123456", "timestamp":1783610513, "event":"USER_UPDATE_MOBILE", "data":"1ojvw2WPvW7LijxS8UvP+rXpPbcLGOmIBNbWetRg7IP0vdhkl", "sign":"111108bb8e6dbce3c9671d6fdb69d15066227608" }
1

Example of Data After Decrypting the Request Body 'data' Field

20200223170310946-34EE-3403BF88A
1

# 4. Request Parameter Description

Parameter Name Type Description
nonce String Random number. Used in conjunction with timestamp to prevent replay attacks.
timestamp Integer Timestamp. Used in conjunction with nonce to prevent replay attacks.
event String Event type, refer to the event list.
data String Message body. Decrypts to the user ID.
sign String Message signature.

# 5. Response Body

Success Example

HTTP/1.1 200 OK
1

Note: Bamboo Cloud IDaaS determines whether the event push was successful solely based on the HTTP status code returned by the application system. A status code of 200 indicates the event push was successful; any other code indicates failure.

# 6. Response Parameters

None

# Get Business Data Interface

The Event Notification Interface pushes the user ID to the application system when an event is triggered. If the application system needs to obtain other attribute information of the user, it can call the Get User Details by User ID interface provided by Bamboo Cloud IDaaS to retrieve user details.

Note: To call this API, you need to apply to the administrator for API access permissions.

Appendix