The Identity Web API uses the REST protocol over SSL. The requests and responses are HTTP and in JSON format.
The web API URL has this structure:
https://<Gateway_IP_Address_or_FQDN>/_IA_API/v1.0/<command>
For example: https://gw.acme.com/_IA_API/v1.0/add-identity
The expected JSON structure is a simple, flat key-value object.
To provide backward and forward compatibility, you can include the Web API version in the request URL, as shown in this table:
URL |
API Version |
Minimal Gateway Version |
---|---|---|
|
1.0 |
R80.10 |
|
1.0 |
R80.10 |
|
Latest |
R80.10 |
Important - URL https://<GW_IP_or_FQDN>/_IA_API/idasdk/<command>
used by R80.10 EA customers is preserved and serves API version 1.0.