{ "opencollection": "1.0.0", "info": { "name": "Catchpoint REST API v2.0 Account Assertions API", "version": "2.0" }, "items": [ { "info": { "name": "Assertions", "type": "folder" }, "items": [ { "info": { "name": "Returns the assertions by the IDs passed.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/assertions", "params": [ { "name": "assertionIds", "value": "", "type": "query", "description": "Comma-separated list of Assertion IDs" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "If no parameters are passed, the details of all assertions for current level are returned." }, { "info": { "name": "Create a new assertion based on the PostData.", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/assertions", "params": [ { "name": "objectDetails", "value": "", "type": "query", "description": "Set to true to return the created object in the response body, otherwise the response body will only return created object ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To get payload for creating a new assertion and to get the created assertion details refer InternalLink[Identity Provider Assertions Endpoint,operations-tag-Assertions,operations-Assertions-get_v2_assertions] Endpoint. (add hyperlink to endpoint). Pass “0” for assertion ID to create a new assertion." }, { "info": { "name": "Update an existing assertion based on the request body.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/assertions", "params": [ { "name": "id", "value": "", "type": "query", "description": "Assertion ID" }, { "name": "objectDetails", "value": "", "type": "query", "description": "Set to true to return the updated object in the response body, otherwise the response body will only return the updated object ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "**Request:**\r\n \r\nOnly the property to be updated can be passed in the request body instead of the whole object. The update request body requires a total of three keys to be filled with appropriate value as listed below:\r\n* **value** – The value property provides the new value.\r\n \r\n* **path** – The path property indicates the element to update. The entire path with slashes needs to be provided here. Example: /status/id\r\n \r\n* **op** – The op property indicates the " }, { "info": { "name": "Delete an existing assertion by parameters passed.", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/assertions", "params": [ { "name": "assertionIds", "value": "", "type": "query", "description": "Comma-separated list of Assertion IDs" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To delete assertions based on the specified list of IDs, the IDs need to be separated by commas. This endpoint allows partial deletion; if you provide a list of five IDs and only three of them are valid, then it will delete those three assertions. The response will indicate the three that were deleted, and the two invalid IDs will be listed as errors." } ] } ], "bundled": true }