Interface Specification
# Interface Format
Zhuyun IDaaS Identity Synchronization OpenAPI adopts the RESTful specification. The request method is POST, and the data format is JSON. The interface specification format is as follows:
| Content | Description |
|---|---|
| Request Specification | Contains the interface request URL, the HTTP method used by the interface, and the request protocol |
| Request Body | Provides request parameter examples and descriptions |
| Parameter Description | Parameter description includes field meaning and value range |
| Return Example | Provides return parameter examples and descriptions |
# Interface Call Instructions
Before calling the API interface, you need to complete the following preparations:
- Create an application resource in the Enterprise Center to obtain the ClientId and ClientSecret. Add IDaaS system API interface permissions. For details, see API Permissions.
- Call the authentication interface to obtain the Access Token. For details, see Authentication Interface.
- Call specific scenario business interfaces. For details, see Interface List.
# Security Settings
To ensure the security of interface calls, it is recommended that when creating an application on the IDaaS Enterprise Center platform, you enter 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 an IP whitelist, you can control and allow only specific IPs to call the API interface to ensure service security.
