IDaaS Open Platform
Customer Identity (CIAM)

API Documentation

This document describes the identity management OpenAPI interface design provided by Bamboo Cloud IDaaS to external parties. The intended readers are application developers integrating with Bamboo Cloud IDaaS.

# Interface Format

The Bamboo Cloud IDaaS identity synchronization OpenAPI follows the RESTful specification. The request method is POST, and the data format is JSON. The interface description format is as follows:

Request Description: Contains the request URL and request method (GET/POST)
...
Request Body:
...
Parameter Description:
...
Request Example:
...
Response Example:
...
Parameter Description:
...
1
2
3
4
5
6
7
8
9
10
11
12

# Interface Call Instructions

  1. Create an application resource in the Enterprise Center, obtain the ClientId and ClientSecret, and add API interface permissions for the IDaaS system. For specific operations, refer to API Authorization.

  2. Call the authentication interface to obtain an Access Token.

  3. Call the specific scenario business interface.

# Security Settings

To ensure the security of interface calls, it is recommended that when creating an application on the IDaaS Enterprise Center platform, you go to the application information page and configure the IP whitelist in the security settings to the egress IP of the server calling the interface. After configuration, the calling IP will be verified when calling the API interface. If the IP is not the configured IP, the call will be rejected. By configuring the IP whitelist, you can control and allow only specific IPs to call the API interface, ensuring service security.

Authentication API