...
Please contact Enterprise Application and System Entitlements (EASE) to both obtain system entitlements to use this service and to verify that all legacy and third party system access has been removed after using this service.
| Table of Contents |
|---|
Testing and Certification
Certification is not required.
Restricted Access
This service is secured using HTTP Basic Access Authentication protocol. All requests must contain client’s API credential in Authorization HTTP header.
Authorization and Entitlement
The following entitlement is required to invoke the service:
...
To obtain system entitlements, contact Enterprise Application and System Entitlements (EASE).
Server Endpoints
| Environment | URL |
|---|---|
| New Release | https://iamwebsvcnr.cmegroup.com/ refsecuritywebservicerefsecuritywebservices/securityservice/revokeEntitlementByEmail |
| Certification | https://iamwebsvccert.cmegroup.com/refsecuritywebservicerefsecuritywebservices/securityservice/revokeEntitlementByEmail |
| Production | https://iamwebsvc.cmegroup.com/refsecuritywebservicerefsecuritywebservices/securityservice/revokeEntitlementByEmail |
HTTP Method
POST
Parameters
Put ‘email’ parameter in HTTP body, for example:
| Code Block | ||
|---|---|---|
| ||
POST /refsecuritywebservices/securityservice/revokeEntitlementByEmail HTTP/1.1 Accept: application/json, application/*+json Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXX Content-Type: application/x-www-form-urlencoded email=johndoe@mycompany.com |
Response
- Successful: HTTP status code 200 is returned.
- Failure: Returns error details in JSON format
Exception Handling
When a service error occurs, a JSON with the following attributes will be returned in HTTP response body.
...
| Code Block | ||
|---|---|---|
| ||
HTTP/1.1 400 Bad Request
Content-Type: application/json
X-UNO-WS-Request-ID: d6d8a01a-1756-4c64-8223-afe26229f309
X-UNO-WS-Internal-Request-ID: 6b0d0a4d-0677-4789-9113-ef2b8d3e02b3
X-UNO-WS-App-API-ID: API_TEST
{
"errorCode":"VALIDATION_ERROR",
"subErrorCodes":["applicationId.NotBlank","role.NotBlank","userId.NotBlank"],
"errorMessage":"Application ID is required, Role is required, User ID is required",
"requestInfo":
{
"appApiId":"API_TEST",
"requestId":"c71e13b9-5ced-4dff-a359-3a185cb5c667",
"internalRequestId": "6b0d0a4d-0677-4789-9113-ef2b8d3e02b3"
}
}
|
Request Tagging
A request can be tracked with a request ID using X-UNO-WS-Request-ID HTTP header. The value should be a unique ID identifying the request. If no value is supplied, service will generate one for you. In addition, any HTTP response from the web service will contain the following header:
...