{ "item": [ { "name": "private", "description": "Management API", "item": [] }, { "name": "Accounts", "description": "", "item": [ { "id": "2738f575-8230-4cd4-84b4-8724590c9f50", "name": "List Accounts", "request": { "name": "List Accounts", "description": { "content": "Lists accounts that the user can access.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that include the specified email address.", "type": "text/plain" }, "key": "userEmail", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that include the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving accounts.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of accounts to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits accounts to those that are children of the specified account ID.", "type": "text/plain" }, "key": "accountID", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7a5afc65-6bef-4d2b-845d-b816f143f638", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that include the specified email address.", "type": "text/plain" }, "key": "userEmail", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that include the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving accounts.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of accounts to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits accounts to those that are children of the specified account ID.", "type": "text/plain" }, "key": "accountID", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accounts\": [\n {\n \"name\": \"8oNk\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ID\": \"\",\n \"namespace\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"status\": \"NONE\",\n \"tenantType\": \"NONE_TYPE\",\n \"accountType\": \"TYPE_NONE\"\n },\n {\n \"name\": \"r3lxi\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ID\": \"\",\n \"namespace\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"status\": \"NONE\",\n \"tenantType\": \"NONE_TYPE\",\n \"accountType\": \"TYPE_NONE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cfd2b87-63d6-4dc0-936a-b7af8dd94c13", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that include the specified email address.", "type": "text/plain" }, "key": "userEmail", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that include the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving accounts.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of accounts to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits accounts to those that are children of the specified account ID.", "type": "text/plain" }, "key": "accountID", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "829d12eb-1026-4a93-b404-56772818c8fb", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that include the specified email address.", "type": "text/plain" }, "key": "userEmail", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that include the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits returned accounts to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving accounts.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of accounts to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits accounts to those that are children of the specified account ID.", "type": "text/plain" }, "key": "accountID", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "790ac154-2c5e-4e6e-b4dc-a6d1b43094d5", "name": "Get Account", "request": { "name": "Get Account", "description": { "content": "Returns an account.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "35045920-4d92-4494-aafd-fb2d25633dd1", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account\": {\n \"name\": \"eK2Te\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ID\": \"\",\n \"namespace\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"status\": \"NONE\",\n \"tenantType\": \"NONE_TYPE\",\n \"accountType\": \"TYPE_NONE\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20e587c2-c81f-4100-9476-42a1272df477", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eae8b901-d851-453e-891a-e73ce53d3dfd", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ead7fea6-b97a-4553-b162-4a79657052cb", "name": "Update Account", "request": { "name": "Update Account", "description": { "content": "Updates an account.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"name\": \"9UofHY6vJe0\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"status\": \"NONE\",\n \"tenantType\": \"NONE_TYPE\",\n \"accountType\": \"TYPE_NONE\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "74273e54-b3c9-43b4-b992-ce38bd8cbc3e", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"name\": \"9UofHY6vJe0\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"status\": \"NONE\",\n \"tenantType\": \"NONE_TYPE\",\n \"accountType\": \"TYPE_NONE\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3d8c5a1-e552-4769-9ae6-016ca90deed5", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"name\": \"9UofHY6vJe0\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"status\": \"NONE\",\n \"tenantType\": \"NONE_TYPE\",\n \"accountType\": \"TYPE_NONE\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82632d17-ddb4-4e51-a4ae-8fc8624e7876", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"name\": \"9UofHY6vJe0\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"status\": \"NONE\",\n \"tenantType\": \"NONE_TYPE\",\n \"accountType\": \"TYPE_NONE\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a56e246-d7d7-4cac-ae55-73414128ae0a", "name": "List Regions", "request": { "name": "List Regions", "description": { "content": "List regions availble to an account. You can create workspaces in available regions.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":accountID", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "accountID", "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "901c14c4-34bc-4e3f-8876-0c013fe76611", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"regions\": {\n \"key_0\": {\n \"regionName\": \"\",\n \"displayName\": \"\",\n \"regionUrl\": \"\",\n \"flagUrl\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de56cdbe-0fac-412c-995d-2d392972f6ff", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09654470-4d6e-43e8-9b6a-c24f723c6865", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "regions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77a70012-39a2-42d1-ab19-fc5ba9222263", "name": "List Resources", "request": { "name": "List Resources", "description": { "content": "List resources under a given resource.", "type": "text/plain" }, "url": { "path": [ "v1", "resources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "dde11e47-ab77-44cc-b3be-26bdc3fcaf06", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "resources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"resources\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "412b4ea2-e17d-439c-8786-b7ed07083645", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "resources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50fc00ed-5793-4736-a1c7-f04f6a7fe94f", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "resources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Audit", "description": "", "item": [ { "id": "a0cf2278-0e59-4a0f-bc18-f4e09f0154e5", "name": "List Audit Events", "request": { "name": "List Audit Events", "description": { "content": "Lists audit events that match query parameters.", "type": "text/plain" }, "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request set by the service that received the request.", "type": "text/plain" }, "key": "filterOps.context.traceID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "NONE" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "ACCESS_NONE" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "AUTH_NONE" }, { "disabled": true, "description": { "content": "ID of the JWT token.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "Embedded User Context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Resources with the specified account ID.", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" }, { "disabled": true, "description": { "content": "Events with the specified action type. (This can only be one of NONE,ASSIGN,CREATE,DELETE,EXECUTE,LIST,READ,UNASSIGN,UPDATE,VALIDATE,LOGIN,ROTATE,SCHEDULEROTATION,SCHEDULEROTATIONALERT,IMPORT,GETIMPORTPARAMETERS,PING,GETCLOUDPROVIDER)", "type": "text/plain" }, "key": "filterOps.actionType", "value": "NONE" }, { "disabled": true, "description": { "content": "Resources with the specified type. (This can only be one of NONE_API,ACCOUNT,AUDIT,BASE_DATA_TYPE,FIELD_TEMPLATE,FILE,KEY,POLICY,PROTO_PARSE,RECORD,ROLE,RULE,SECRET,SERVICE_ACCOUNT,TOKEN,USER,VAULT,VAULT_TEMPLATE,WORKSPACE,TABLE,POLICY_TEMPLATE,MEMBER,TAG,CONNECTION,MIGRATION,SCHEDULED_JOB,JOB,COLUMN_NAME,NETWORK_TOKEN,SUBSCRIPTION)", "type": "text/plain" }, "key": "filterOps.resourceType", "value": "NONE_API" }, { "disabled": true, "description": { "content": "Events with associated tags. If an event matches at least one tag, the event is returned. Comma-separated list. For example, \"login, get\".", "type": "text/plain" }, "key": "filterOps.tags", "value": "" }, { "disabled": true, "description": { "content": "HTTP response code of the request.", "type": "text/plain" }, "key": "filterOps.responseCode", "value": "" }, { "disabled": true, "description": { "content": "Start timestamp for the query, in SQL format.", "type": "text/plain" }, "key": "filterOps.startTime", "value": "" }, { "disabled": true, "description": { "content": "End timestamp for the query, in SQL format.", "type": "text/plain" }, "key": "filterOps.endTime", "value": "" }, { "disabled": true, "description": { "content": "Name of the API called in the request.", "type": "text/plain" }, "key": "filterOps.apiName", "value": "" }, { "disabled": true, "description": { "content": "Response message of the request.", "type": "text/plain" }, "key": "filterOps.responseMessage", "value": "" }, { "disabled": true, "description": { "content": "HTTP method of the request.", "type": "text/plain" }, "key": "filterOps.httpMethod", "value": "" }, { "disabled": true, "description": { "content": "HTTP URI of the request.", "type": "text/plain" }, "key": "filterOps.httpURI", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Timestamp provided in the previous audit response's `nextOps` attribute. An alternate way to manage response pagination. Can't be used with `sortOps` or `offset`. For the first request in a series of audit requests, leave blank.", "type": "text/plain" }, "key": "afterOps.timestamp", "value": "" }, { "disabled": true, "description": { "content": "Change ID provided in the previous audit response's `nextOps` attribute. An alternate way to manage response pagination. Can't be used with `sortOps` or `offset`. For the first request in a series of audit requests, leave blank.", "type": "text/plain" }, "key": "afterOps.changeID", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Record position at which to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "56d806ba-40f8-4d43-850e-87e726284c55", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request set by the service that received the request.", "type": "text/plain" }, "key": "filterOps.context.traceID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "NONE" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "ACCESS_NONE" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "AUTH_NONE" }, { "disabled": true, "description": { "content": "ID of the JWT token.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "Embedded User Context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Resources with the specified account ID.", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" }, { "disabled": true, "description": { "content": "Events with the specified action type. (This can only be one of NONE,ASSIGN,CREATE,DELETE,EXECUTE,LIST,READ,UNASSIGN,UPDATE,VALIDATE,LOGIN,ROTATE,SCHEDULEROTATION,SCHEDULEROTATIONALERT,IMPORT,GETIMPORTPARAMETERS,PING,GETCLOUDPROVIDER)", "type": "text/plain" }, "key": "filterOps.actionType", "value": "NONE" }, { "disabled": true, "description": { "content": "Resources with the specified type. (This can only be one of NONE_API,ACCOUNT,AUDIT,BASE_DATA_TYPE,FIELD_TEMPLATE,FILE,KEY,POLICY,PROTO_PARSE,RECORD,ROLE,RULE,SECRET,SERVICE_ACCOUNT,TOKEN,USER,VAULT,VAULT_TEMPLATE,WORKSPACE,TABLE,POLICY_TEMPLATE,MEMBER,TAG,CONNECTION,MIGRATION,SCHEDULED_JOB,JOB,COLUMN_NAME,NETWORK_TOKEN,SUBSCRIPTION)", "type": "text/plain" }, "key": "filterOps.resourceType", "value": "NONE_API" }, { "disabled": true, "description": { "content": "Events with associated tags. If an event matches at least one tag, the event is returned. Comma-separated list. For example, \"login, get\".", "type": "text/plain" }, "key": "filterOps.tags", "value": "" }, { "disabled": true, "description": { "content": "HTTP response code of the request.", "type": "text/plain" }, "key": "filterOps.responseCode", "value": "" }, { "disabled": true, "description": { "content": "Start timestamp for the query, in SQL format.", "type": "text/plain" }, "key": "filterOps.startTime", "value": "" }, { "disabled": true, "description": { "content": "End timestamp for the query, in SQL format.", "type": "text/plain" }, "key": "filterOps.endTime", "value": "" }, { "disabled": true, "description": { "content": "Name of the API called in the request.", "type": "text/plain" }, "key": "filterOps.apiName", "value": "" }, { "disabled": true, "description": { "content": "Response message of the request.", "type": "text/plain" }, "key": "filterOps.responseMessage", "value": "" }, { "disabled": true, "description": { "content": "HTTP method of the request.", "type": "text/plain" }, "key": "filterOps.httpMethod", "value": "" }, { "disabled": true, "description": { "content": "HTTP URI of the request.", "type": "text/plain" }, "key": "filterOps.httpURI", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Timestamp provided in the previous audit response's `nextOps` attribute. An alternate way to manage response pagination. Can't be used with `sortOps` or `offset`. For the first request in a series of audit requests, leave blank.", "type": "text/plain" }, "key": "afterOps.timestamp", "value": "" }, { "disabled": true, "description": { "content": "Change ID provided in the previous audit response's `nextOps` attribute. An alternate way to manage response pagination. Can't be used with `sortOps` or `offset`. For the first request in a series of audit requests, leave blank.", "type": "text/plain" }, "key": "afterOps.changeID", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Record position at which to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"event\": [\n {\n \"context\": {\n \"changeID\": \"\",\n \"requestID\": \"\",\n \"traceID\": \"\",\n \"sessionID\": \"\",\n \"actor\": \"\",\n \"actorType\": \"NONE\",\n \"accessType\": \"ACCESS_NONE\",\n \"ipAddress\": \"\",\n \"origin\": \"\",\n \"authMode\": \"AUTH_NONE\",\n \"jwtID\": \"\",\n \"bearerTokenContextID\": \"\"\n },\n \"request\": {\n \"data\": {\n \"content\": \"\"\n },\n \"apiName\": \"\",\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\",\n \"actionType\": \"NONE\",\n \"resourceType\": \"NONE_API\",\n \"httpInfo\": {\n \"URI\": \"\",\n \"method\": \"\"\n }\n },\n \"response\": {\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"content\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"parentAccountID\": \"\",\n \"accountID\": \"\",\n \"resourceIDs\": [\n \"\",\n \"\"\n ]\n },\n {\n \"context\": {\n \"changeID\": \"\",\n \"requestID\": \"\",\n \"traceID\": \"\",\n \"sessionID\": \"\",\n \"actor\": \"\",\n \"actorType\": \"NONE\",\n \"accessType\": \"ACCESS_NONE\",\n \"ipAddress\": \"\",\n \"origin\": \"\",\n \"authMode\": \"AUTH_NONE\",\n \"jwtID\": \"\",\n \"bearerTokenContextID\": \"\"\n },\n \"request\": {\n \"data\": {\n \"content\": \"\"\n },\n \"apiName\": \"\",\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"timestamp\": \"\",\n \"actionType\": \"NONE\",\n \"resourceType\": \"NONE_API\",\n \"httpInfo\": {\n \"URI\": \"\",\n \"method\": \"\"\n }\n },\n \"response\": {\n \"code\": \"\",\n \"message\": \"\",\n \"data\": {\n \"content\": \"\"\n },\n \"timestamp\": \"\"\n },\n \"parentAccountID\": \"\",\n \"accountID\": \"\",\n \"resourceIDs\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"nextOps\": {\n \"timestamp\": \"\",\n \"changeID\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0a933bf-9a35-45ac-84d8-9a5720b8f36e", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request set by the service that received the request.", "type": "text/plain" }, "key": "filterOps.context.traceID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "NONE" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "ACCESS_NONE" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "AUTH_NONE" }, { "disabled": true, "description": { "content": "ID of the JWT token.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "Embedded User Context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Resources with the specified account ID.", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" }, { "disabled": true, "description": { "content": "Events with the specified action type. (This can only be one of NONE,ASSIGN,CREATE,DELETE,EXECUTE,LIST,READ,UNASSIGN,UPDATE,VALIDATE,LOGIN,ROTATE,SCHEDULEROTATION,SCHEDULEROTATIONALERT,IMPORT,GETIMPORTPARAMETERS,PING,GETCLOUDPROVIDER)", "type": "text/plain" }, "key": "filterOps.actionType", "value": "NONE" }, { "disabled": true, "description": { "content": "Resources with the specified type. (This can only be one of NONE_API,ACCOUNT,AUDIT,BASE_DATA_TYPE,FIELD_TEMPLATE,FILE,KEY,POLICY,PROTO_PARSE,RECORD,ROLE,RULE,SECRET,SERVICE_ACCOUNT,TOKEN,USER,VAULT,VAULT_TEMPLATE,WORKSPACE,TABLE,POLICY_TEMPLATE,MEMBER,TAG,CONNECTION,MIGRATION,SCHEDULED_JOB,JOB,COLUMN_NAME,NETWORK_TOKEN,SUBSCRIPTION)", "type": "text/plain" }, "key": "filterOps.resourceType", "value": "NONE_API" }, { "disabled": true, "description": { "content": "Events with associated tags. If an event matches at least one tag, the event is returned. Comma-separated list. For example, \"login, get\".", "type": "text/plain" }, "key": "filterOps.tags", "value": "" }, { "disabled": true, "description": { "content": "HTTP response code of the request.", "type": "text/plain" }, "key": "filterOps.responseCode", "value": "" }, { "disabled": true, "description": { "content": "Start timestamp for the query, in SQL format.", "type": "text/plain" }, "key": "filterOps.startTime", "value": "" }, { "disabled": true, "description": { "content": "End timestamp for the query, in SQL format.", "type": "text/plain" }, "key": "filterOps.endTime", "value": "" }, { "disabled": true, "description": { "content": "Name of the API called in the request.", "type": "text/plain" }, "key": "filterOps.apiName", "value": "" }, { "disabled": true, "description": { "content": "Response message of the request.", "type": "text/plain" }, "key": "filterOps.responseMessage", "value": "" }, { "disabled": true, "description": { "content": "HTTP method of the request.", "type": "text/plain" }, "key": "filterOps.httpMethod", "value": "" }, { "disabled": true, "description": { "content": "HTTP URI of the request.", "type": "text/plain" }, "key": "filterOps.httpURI", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Timestamp provided in the previous audit response's `nextOps` attribute. An alternate way to manage response pagination. Can't be used with `sortOps` or `offset`. For the first request in a series of audit requests, leave blank.", "type": "text/plain" }, "key": "afterOps.timestamp", "value": "" }, { "disabled": true, "description": { "content": "Change ID provided in the previous audit response's `nextOps` attribute. An alternate way to manage response pagination. Can't be used with `sortOps` or `offset`. For the first request in a series of audit requests, leave blank.", "type": "text/plain" }, "key": "afterOps.changeID", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Record position at which to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d94fcbf-d100-4c89-b985-3ad47b027378", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "audit", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID for the audit event.", "type": "text/plain" }, "key": "filterOps.context.changeID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request that caused the event.", "type": "text/plain" }, "key": "filterOps.context.requestID", "value": "" }, { "disabled": true, "description": { "content": "ID for the request set by the service that received the request.", "type": "text/plain" }, "key": "filterOps.context.traceID", "value": "" }, { "disabled": true, "description": { "content": "ID for the session in which the request was sent.", "type": "text/plain" }, "key": "filterOps.context.sessionID", "value": "" }, { "disabled": true, "description": { "content": "Member who sent the request. Depending on `actorType`, this may be a user ID or a service account ID.", "type": "text/plain" }, "key": "filterOps.context.actor", "value": "" }, { "disabled": true, "description": { "content": "Type of member who sent the request. (This can only be one of NONE,USER,SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.context.actorType", "value": "NONE" }, { "disabled": true, "description": { "content": "Type of access for the request. (This can only be one of ACCESS_NONE,API,SQL,OKTA_LOGIN)", "type": "text/plain" }, "key": "filterOps.context.accessType", "value": "ACCESS_NONE" }, { "disabled": true, "description": { "content": "IP Address of the client that made the request.", "type": "text/plain" }, "key": "filterOps.context.ipAddress", "value": "" }, { "disabled": true, "description": { "content": "HTTP Origin request header (including scheme, hostname, and port) of the request.", "type": "text/plain" }, "key": "filterOps.context.origin", "value": "" }, { "disabled": true, "description": { "content": "Authentication mode the `actor` used. (This can only be one of AUTH_NONE,OKTA_JWT,SERVICE_ACCOUNT_JWT,PAT_JWT)", "type": "text/plain" }, "key": "filterOps.context.authMode", "value": "AUTH_NONE" }, { "disabled": true, "description": { "content": "ID of the JWT token.", "type": "text/plain" }, "key": "filterOps.context.jwtID", "value": "" }, { "disabled": true, "description": { "content": "Embedded User Context.", "type": "text/plain" }, "key": "filterOps.context.bearerTokenContextID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified parent account ID.", "type": "text/plain" }, "key": "filterOps.parentAccountID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Resources with the specified account ID.", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified workspace ID.", "type": "text/plain" }, "key": "filterOps.workspaceID", "value": "" }, { "disabled": true, "description": { "content": "Resources with the specified vault ID.", "type": "text/plain" }, "key": "filterOps.vaultID", "value": "" }, { "disabled": true, "description": { "content": "Resources with a specified ID. If a resource matches at least one ID, the associated event is returned. Format is a comma-separated list of \"\\/\\\". For example, \"VAULT/12345, USER/67890\".", "type": "text/plain" }, "key": "filterOps.resourceIDs", "value": "" }, { "disabled": true, "description": { "content": "Events with the specified action type. (This can only be one of NONE,ASSIGN,CREATE,DELETE,EXECUTE,LIST,READ,UNASSIGN,UPDATE,VALIDATE,LOGIN,ROTATE,SCHEDULEROTATION,SCHEDULEROTATIONALERT,IMPORT,GETIMPORTPARAMETERS,PING,GETCLOUDPROVIDER)", "type": "text/plain" }, "key": "filterOps.actionType", "value": "NONE" }, { "disabled": true, "description": { "content": "Resources with the specified type. (This can only be one of NONE_API,ACCOUNT,AUDIT,BASE_DATA_TYPE,FIELD_TEMPLATE,FILE,KEY,POLICY,PROTO_PARSE,RECORD,ROLE,RULE,SECRET,SERVICE_ACCOUNT,TOKEN,USER,VAULT,VAULT_TEMPLATE,WORKSPACE,TABLE,POLICY_TEMPLATE,MEMBER,TAG,CONNECTION,MIGRATION,SCHEDULED_JOB,JOB,COLUMN_NAME,NETWORK_TOKEN,SUBSCRIPTION)", "type": "text/plain" }, "key": "filterOps.resourceType", "value": "NONE_API" }, { "disabled": true, "description": { "content": "Events with associated tags. If an event matches at least one tag, the event is returned. Comma-separated list. For example, \"login, get\".", "type": "text/plain" }, "key": "filterOps.tags", "value": "" }, { "disabled": true, "description": { "content": "HTTP response code of the request.", "type": "text/plain" }, "key": "filterOps.responseCode", "value": "" }, { "disabled": true, "description": { "content": "Start timestamp for the query, in SQL format.", "type": "text/plain" }, "key": "filterOps.startTime", "value": "" }, { "disabled": true, "description": { "content": "End timestamp for the query, in SQL format.", "type": "text/plain" }, "key": "filterOps.endTime", "value": "" }, { "disabled": true, "description": { "content": "Name of the API called in the request.", "type": "text/plain" }, "key": "filterOps.apiName", "value": "" }, { "disabled": true, "description": { "content": "Response message of the request.", "type": "text/plain" }, "key": "filterOps.responseMessage", "value": "" }, { "disabled": true, "description": { "content": "HTTP method of the request.", "type": "text/plain" }, "key": "filterOps.httpMethod", "value": "" }, { "disabled": true, "description": { "content": "HTTP URI of the request.", "type": "text/plain" }, "key": "filterOps.httpURI", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Timestamp provided in the previous audit response's `nextOps` attribute. An alternate way to manage response pagination. Can't be used with `sortOps` or `offset`. For the first request in a series of audit requests, leave blank.", "type": "text/plain" }, "key": "afterOps.timestamp", "value": "" }, { "disabled": true, "description": { "content": "Change ID provided in the previous audit response's `nextOps` attribute. An alternate way to manage response pagination. Can't be used with `sortOps` or `offset`. For the first request in a series of audit requests, leave blank.", "type": "text/plain" }, "key": "afterOps.changeID", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Record position at which to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Authentication", "description": "", "item": [ { "id": "12465789-11d8-4f62-ba5c-ba19ec5be0ec", "name": "Get Bearer Token", "request": { "name": "Get Bearer Token", "description": { "content": "

Generates a Bearer Token to authenticate with Skyflow. This method doesn't require the Authorization header.

Note: For recommended ways to authenticate, see API authentication.

", "type": "text/plain" }, "url": { "path": [ "v1", "auth", "sa", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assertion\": \"\",\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"requested_token_use\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3150cc3a-7abe-4578-bc88-3afd145615d2", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "auth", "sa", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assertion\": \"\",\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"requested_token_use\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accessToken\": \"\",\n \"tokenType\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d492da8c-5055-4bf6-84d7-6a24eabddf2b", "name": "Invalid scope format.", "originalRequest": { "url": { "path": [ "v1", "auth", "sa", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assertion\": \"\",\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"requested_token_use\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a41a0af9-5a92-4cee-a82d-07722f668607", "name": "Key expired or JWT token unparseable.", "originalRequest": { "url": { "path": [ "v1", "auth", "sa", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assertion\": \"\",\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"requested_token_use\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beeb5515-5264-4774-be78-b5a0a66fa818", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "auth", "sa", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assertion\": \"\",\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"requested_token_use\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b567fe39-12f7-4b81-b311-ebc11b583d43", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "auth", "sa", "oauth", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assertion\": \"\",\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"requested_token_use\": \"\",\n \"scope\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Connections", "description": "", "item": [ { "id": "b53f9a99-5f89-4832-a15b-be734ea37c6c", "name": "List Inbound Connections", "request": { "name": "List Inbound Connections", "description": { "content": "List inbound connections for the specified vault.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "inboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the vault.", "type": "text/plain" }, "key": "vaultID", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns connection IDs.", "type": "text/plain" }, "key": "fetchIDonly", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ccc66a9c-fbd0-4fe0-824a-1c98540d55f3", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the vault.", "type": "text/plain" }, "key": "vaultID", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns connection IDs.", "type": "text/plain" }, "key": "fetchIDonly", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ConnectionMappings\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "967ebb4a-8ad1-40ca-b7fe-4d1295f5d5ab", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the vault.", "type": "text/plain" }, "key": "vaultID", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns connection IDs.", "type": "text/plain" }, "key": "fetchIDonly", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b1e2685-2aca-4aab-94cd-84339e25d63b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the vault.", "type": "text/plain" }, "key": "vaultID", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns connection IDs.", "type": "text/plain" }, "key": "fetchIDonly", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "064ceaa4-bb5c-4bd1-85e2-3e1d66c2ecea", "name": "Create Inbound Connection", "request": { "name": "Create Inbound Connection", "description": { "content": "Creates an inbound connection.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "inboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4ec708ce-df2f-4079-8f84-f9977f005c04", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"connectionURL\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d84cf692-b44b-4bba-a719-c33189761228", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cabe4cce-640e-4e27-a5d2-0439c1f3455d", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "883646ce-4e07-4a55-86cd-8bfa1be2b601", "name": "Delete Inbound Connection", "request": { "name": "Delete Inbound Connection", "description": { "content": "Deletes the specified inbound connection.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "9911711c-7057-451e-a26b-37ff4dbffc44", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bee9c21c-fb18-47c2-b961-39868605cc15", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4af58d31-1e5b-4a80-bc8d-aae97aa29238", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec69158b-d5d4-46de-93f9-9c9f166f4822", "name": "Get Inbound Connection", "request": { "name": "Get Inbound Connection", "description": { "content": "Returns the specified inbound connection.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "58ff4a94-82d9-4cda-8a4e-176a04331d8d", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85d8907c-aa87-44dc-b585-3f1cef6465f4", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0fcf0a8-ae47-4ba4-95aa-4392874b29c6", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d96e27e1-2604-4582-925f-79ee777c188a", "name": "Update Inbound Connection ", "request": { "name": "Update Inbound Connection ", "description": { "content": "Updates the specified inbound connection.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9b071a01-ce79-4aad-9a80-25ebca07ae97", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83697329-58c1-4bfa-ac45-5a844a79a905", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccc30bbb-a886-4a5c-9127-080acc29fab0", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55b62947-b4a3-4c55-ad62-82d175304061", "name": "Update Connection Secrets", "request": { "name": "Update Connection Secrets", "description": { "content": "Update the specified secrets for a connection. Other secrets aren't updated. All properties for a secret must be specified together. For example, to update the `routeSecret`, you must specify both `publicKey` and `privateKey`.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", ":connectionID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "connectionID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "3dcb41c7-8f76-4650-a184-0bfb94ca45e3", "name": "Secrets updated successfully.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":connectionID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "connectionID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfbfa678-bde6-4368-8315-213bcf160942", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":connectionID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "connectionID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e259f496-3517-409d-b84c-06a5aa67f453", "name": "Get Connection Secrets", "request": { "name": "Get Connection Secrets", "description": { "content": "Identifies which secrets are set for a connection. Secret values are redacted. Returns 404 if no secrets are found.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", ":connectionID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "connectionID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4a33c8ac-9475-46fc-bf0b-2096a29e587e", "name": "Secrets for the connection.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":connectionID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "connectionID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" } ], "body": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "144932ad-25ae-45a6-82fb-e9340c23ee91", "name": "No secrets found for the connection.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":connectionID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "connectionID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" } ], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e70bc982-539b-4de5-ac15-da9292abe35d", "name": "Unexpected error.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":connectionID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "connectionID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [], "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca94cace-0d47-4d76-925b-79d10bdf3724", "name": "Upload Authentication Credentials (Inbound)", "request": { "name": "Upload Authentication Credentials (Inbound)", "description": { "content": "Uploads authentication information for an inbound connection.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4ce6392f-983c-4200-a574-d1914a7053b5", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfedc495-3c5f-4d3e-92a0-cb341e2d6823", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95020673-e9e4-4545-84c1-93c6a9750756", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "inboundRoutes", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a77a707-5c59-4cc8-974e-d30e5c63ebb7", "name": "List Outbound Connections", "request": { "name": "List Outbound Connections", "description": { "content": "Lists outbound connections for the specified vault.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "outboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the vault.", "type": "text/plain" }, "key": "vaultID", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns connection IDs.", "type": "text/plain" }, "key": "fetchIDonly", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "8c01ec8a-c996-4988-940b-d903fc7fcd5d", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the vault.", "type": "text/plain" }, "key": "vaultID", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns connection IDs.", "type": "text/plain" }, "key": "fetchIDonly", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ConnectionMappings\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "514159ba-bc23-46b3-bec0-bdf99547003a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the vault.", "type": "text/plain" }, "key": "vaultID", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns connection IDs.", "type": "text/plain" }, "key": "fetchIDonly", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a10c4ab6-675f-464d-8409-3dd4c2076a20", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the vault.", "type": "text/plain" }, "key": "vaultID", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns connection IDs.", "type": "text/plain" }, "key": "fetchIDonly", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2dbeca6c-2f4c-4521-8396-3366c678d9b4", "name": "Create Outbound Connection", "request": { "name": "Create Outbound Connection", "description": { "content": "Creates an outbound connection for a vault.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "outboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "473c3346-fb74-4381-bdae-ce11d3bc1607", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"connectionURL\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39e9ed03-18b0-4af1-8e08-c7310d6c6ffb", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c09365c-151e-4eb9-b367-510c607d4661", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8019a062-c335-410a-8a42-d606a2528189", "name": "Delete Outbound Connection", "request": { "name": "Delete Outbound Connection", "description": { "content": "Deletes the specified outbound connection.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "ff1e13fa-902a-4021-bcab-885f28f50773", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61f16eb4-3da9-4dc7-892f-596da1367bfa", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53be1e7e-0a10-43e4-994a-928a58f7b227", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "843747cf-0252-4ded-a3c0-8b7424ff183d", "name": "Get Outbound Connection", "request": { "name": "Get Outbound Connection", "description": { "content": "Returns the specified outbound connection.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5d7aa8be-57a3-4696-b1aa-b7f9c8d486b0", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb0708d3-681b-46fd-8823-d1dc1d7f7a47", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f22a644-a5c3-4da3-8659-46a0ba7f7eb4", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae1e20b8-9c1a-4182-bdf7-16794378d0cc", "name": "Update Outbound Connection ", "request": { "name": "Update Outbound Connection ", "description": { "content": "Updates the specified outbound connection .", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2a8df955-d8d4-45fb-a099-bad35471ee1a", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04ce5f55-6c17-4c08-b352-d6b85c80f2a6", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efb7bbd6-c107-4ab3-a6ee-57be120cedb4", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"baseURL\": \"\",\n \"vaultID\": \"\",\n \"routes\": [\n {\n \"path\": \"\",\n \"method\": \"\",\n \"contentType\": \"JSON\",\n \"url\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseBody\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"responseHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"queryParams\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"requestHeader\": [\n {\n \"action\": \"NOT_SELECTED\",\n \"fieldName\": \"\",\n \"table\": \"\",\n \"column\": \"\",\n \"dataSelector\": \"\",\n \"dataSelectorRegex\": \"\",\n \"transformFormat\": \"\",\n \"encryptionType\": \"\",\n \"redaction\": \"DEFAULT\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\"\n }\n ],\n \"name\": \"\",\n \"description\": \"\",\n \"soapAction\": \"\",\n \"mleType\": \"NOT_REQUIRED\",\n \"preFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldRequestMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"preFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"postFieldResponseMessageActions\": [\n {\n \"type\": \"NOACTION\",\n \"action\": \"\",\n \"keyEncryptionAlgo\": \"\",\n \"contentEncryptionAlgo\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sourceRegex\": \"\",\n \"transformedRegex\": \"\",\n \"target\": \"\"\n }\n ],\n \"tableUpsertInfo\": [\n {\n \"table\": \"\",\n \"column\": \"\"\n }\n ]\n }\n ],\n \"authMode\": \"NOAUTH\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"denyPassThrough\": \"\",\n \"formEncodedKeysPassThrough\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a36e8d91-8898-4ea2-b48f-d208ebb875fb", "name": "Upload Authentication Credentials (Outbound)", "request": { "name": "Upload Authentication Credentials (Outbound)", "description": { "content": "Uploads authentication information for an outbound connection.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "9e9a3b38-81bd-483b-8ab5-f33dd87f0307", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09c87354-d5e0-4e0d-b1c3-5041e8457a1c", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76edb079-03c7-4b0e-b0ef-12111a21e5b8", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", "outboundRoutes", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"authMode\": \"NOAUTH\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "375856e2-40b9-4dfa-b9f2-9bcb59f251a2", "name": "Get Connection Secrets", "request": { "name": "Get Connection Secrets", "description": { "content": "Identifies which secrets are set for a connection. Secret values are redacted. Returns 404 if no secrets are found.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "aa2c0875-02d3-44e8-80d6-49e4afe47c66", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"authMode\": \"MTLS\",\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21dbf378-9087-42c2-a704-818bec10dca4", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c9f245d-0901-45ae-896a-e0d8281a836f", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "853aa839-7fbb-4e30-b673-684afc3c8604", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e2d4dbc-b6a2-42d1-b4f3-73a13c234bc6", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3f6b559-5dba-404e-a768-7c8852f28c69", "name": "Update Connection Secrets", "request": { "name": "Update Connection Secrets", "description": { "content": "Update the specified secrets for a connection. Other secrets aren't updated. All properties for a secret must be specified together. For example, to update the `routeSecret`, you must specify both `publicKey` and `privateKey`.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"authMode\": \"MTLS\",\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d8b2a04e-8fa5-418b-afb2-197b26f0091e", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"authMode\": \"MTLS\",\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d77662a2-a7f2-470e-9dc3-e357c1406509", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"authMode\": \"MTLS\",\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3c3f876-f623-4a2a-8401-f34bdf0fee79", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"authMode\": \"MTLS\",\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4771016-402d-429c-a4af-10dde9d70c61", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"authMode\": \"MTLS\",\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebc4ab95-5d98-4873-8ff9-4f6abb809b5c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routeSecret\": {\n \"sharedKey\": \"\",\n \"publicKey\": \"\",\n \"privateKey\": \"\"\n },\n \"authMode\": \"MTLS\",\n \"mleAuthSecret\": {\n \"publicKeyMLE\": \"\",\n \"privateKeyMLE\": \"\",\n \"keyID\": \"\"\n },\n \"soapAuthSecret\": {\n \"keyStore\": \"\",\n \"binarySecurityToken\": \"\",\n \"userName\": \"\",\n \"password\": \"\",\n \"keyStorePassword\": \"\"\n },\n \"messageSecrets\": {\n \"encPublicKey\": \"\",\n \"encPrivateKey\": \"\",\n \"signPublicKey\": \"\",\n \"signPrivateKey\": \"\",\n \"encSymmetricKey\": \"\",\n \"signSymmetricKey\": \"\"\n },\n \"fieldEncryptionSecret\": \"\",\n \"oAuth1aSecret\": {\n \"consumerKey\": \"\",\n \"consumerSecret\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8eb1a986-62d4-4c2c-a8f2-c10782da14e4", "name": "Delete Connection Secrets", "request": { "name": "Delete Connection Secrets", "description": { "content": "Deletes the specified secrets for a connection. Provide secret keys to delete as field paths in the connection secret object (e.g., \"messageSecrets.encPublicKey\", \"soapAuthSecret\"). See Get Connection Secrets for the connection secret object schema.", "type": "text/plain" }, "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"secrets\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "271e06f6-84fd-4f13-8f5d-092335a7c9b6", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"secrets\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d66159b-4bbc-4b6f-8672-2e5debec2e34", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"secrets\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "191d15a0-acc8-4396-8b06-752358e3b30a", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"secrets\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "634a3d9e-d801-44a4-821c-291cf048804f", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"secrets\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f34d2b4-5761-4fe6-a3e3-0d4b46d57e83", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "gateway", ":ID", "secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the connection.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"secrets\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Data Types", "description": "", "item": [ { "id": "e91b8c2c-0428-4d11-9250-9eff92959e60", "name": "List Base Data Types", "request": { "name": "List Base Data Types", "description": { "content": "Lists the base data types supported in vault schema.", "type": "text/plain" }, "url": { "path": [ "v1", "base-data-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5230d110-e842-48e4-8121-0a9131745faa", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "base-data-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"baseDataTypes\": [\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"datatype\": \"DT_DATE\"\n },\n {\n \"displayName\": \"\",\n \"description\": \"\",\n \"datatype\": \"DT_FLOAT64\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9afa05f-0aba-4698-bad6-836eb685e867", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "base-data-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b55e1ddb-1183-4ea5-83c4-40294d45c0cb", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "base-data-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fccdd809-0d34-4a2b-aad3-d86c1dc3688b", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "base-data-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8cf501c-6913-48ea-b725-8a1c1c784114", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "base-data-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6996cd5a-7bb7-456d-986f-31da74943e1e", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "base-data-types" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6ab07b62-25d4-406f-bdbf-c03461aa9ed4", "name": "List Skyflow Data Types", "request": { "name": "List Skyflow Data Types", "description": { "content": "Returns availble Skyflow Data Types.", "type": "text/plain" }, "url": { "path": [ "v1", "field-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "29e28e50-9ff3-4cab-ab2b-17b448d11704", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "field-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"fieldTemplates\": [\n {\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"field\": {\n \"name\": \"\",\n \"datatype\": \"DT_DATE\",\n \"isArray\": \"\",\n \"properties\": {},\n \"ID\": \"\"\n },\n \"namespace\": \"\",\n \"status\": \"CREATED\"\n },\n {\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"field\": {\n \"name\": \"\",\n \"datatype\": \"DT_INT16\",\n \"isArray\": \"\",\n \"properties\": {},\n \"ID\": \"\"\n },\n \"namespace\": \"\",\n \"status\": \"DELETION_IN_PROGRESS\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84ef03e0-5b70-4ac0-8810-abb3da1c7091", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "field-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab3a7fc5-f31c-4d44-8497-5ac0865f5d9b", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "field-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a65e4873-f55a-4cb8-bb30-af8af212f6d9", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "field-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dab6dc5c-4aae-4afe-bb05-247ed724f776", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "field-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21b628aa-5494-4aae-80dc-123d1261ccd3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "field-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8f936b6-fbc8-428c-aece-54940e64ced1", "name": "Get Skyflow Data Type", "request": { "name": "Get Skyflow Data Type", "description": { "content": "Returns the specified Skyflow Data Type.", "type": "text/plain" }, "url": { "path": [ "v1", "field-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2484338c-a9b1-4609-9e58-2bb0dc7a7199", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "field-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"template\": {\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"field\": {\n \"name\": \"\",\n \"datatype\": \"DT_UINT16\",\n \"isArray\": \"\",\n \"properties\": {},\n \"ID\": \"\"\n },\n \"namespace\": \"\",\n \"status\": \"CREATED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "000bd9ed-87ff-48ef-a7fe-c624f7117797", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "field-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae5f7124-9a9e-47d9-9923-6cd5c0589a0b", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "field-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f758d36-d314-4d6e-b63c-2796737592e0", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "field-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c28f3150-56c2-46ca-96b6-16c978da7312", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "field-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12732adc-0f44-4e78-897f-a96942ff6674", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "field-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Detect Configurations", "description": "", "item": [] }, { "name": "Functions", "description": "", "item": [ { "id": "b2403032-40e4-4e21-8341-3388b02ada5f", "name": "Get Function Config", "request": { "name": "Get Function Config", "description": { "content": "Returns the specified function configuration.", "type": "text/plain" }, "url": { "path": [ "v1", "functionConfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d9174b53-2032-4281-a04f-253da5505a7c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionConfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"dependencies\": [\n {\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"whitelistedDependencies\": [\n \"\",\n \"\"\n ]\n },\n {\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"whitelistedDependencies\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"whitelistedConnectionBaseURLs\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68238636-edbd-465e-ac06-fe2a080d6fcc", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionConfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "386510b5-bc49-41ca-a81b-817258f3af6b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionConfig" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "214d2484-c60c-4258-913f-6dec3f67162d", "name": "List Function Deployments", "request": { "name": "List Function Deployments", "description": { "content": "Returns all function deployments in the account.", "type": "text/plain" }, "url": { "path": [ "v1", "functionDeployments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "functionID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "functionEnvironmentID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "versionTag", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cf976078-46ce-4074-b927-7454f06ca364", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionDeployments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "functionID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "functionEnvironmentID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "versionTag", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionDeployments\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\",\n \"status\": \"NONE\",\n \"methodNames\": [\n \"\",\n \"\"\n ],\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"errorMessage\": \"\",\n \"regionID\": \"\",\n \"functionEnvironmentName\": \"\",\n \"description\": \"\"\n },\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\",\n \"status\": \"NONE\",\n \"methodNames\": [\n \"\",\n \"\"\n ],\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"errorMessage\": \"\",\n \"regionID\": \"\",\n \"functionEnvironmentName\": \"\",\n \"description\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f242995d-7923-44ef-beed-dafb990b064a", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "functionID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "functionEnvironmentID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "versionTag", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3bc769f-df52-4fae-99f5-829728d19103", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "functionID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "functionEnvironmentID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "versionTag", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c80d5fa-bbff-4cb5-9879-d4e94c790396", "name": "Create Function Deployment", "request": { "name": "Create Function Deployment", "description": { "content": "Creates a new deployment.", "type": "text/plain" }, "url": { "path": [ "v1", "functionDeployments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "337f7e0f-e3ca-4566-b7b2-380e4d9d692c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionDeployments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionDeploymentID\": \"\",\n \"status\": \"NONE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0407e4c-415b-4be9-97a6-6103551d46af", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13a6b463-4a1c-41ac-a90c-aa473fdc6e8a", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee449c4d-6ade-40d2-8ea2-c0db42042a5a", "name": "Delete Function Deployment", "request": { "name": "Delete Function Deployment", "description": { "content": "Deletes the specified function deployment.", "type": "text/plain" }, "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "52c63b46-8781-4d1e-a957-adf7203438f9", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"status\": \"NONE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4068096-cf07-4d0a-aa5a-3c3707871dd6", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7a9cc6d-e3b1-4cb5-85a3-bd434bc6bcf0", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aabe93d1-2496-48c6-8643-bae70efdead8", "name": "Get Function Deployment", "request": { "name": "Get Function Deployment", "description": { "content": "Returns the specified function deployment.", "type": "text/plain" }, "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "verbose", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "eb50ce1d-d881-4653-a36b-07e5e9f2339d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "verbose", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\",\n \"status\": \"NONE\",\n \"methodNames\": [\n \"\",\n \"\"\n ],\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"errorMessage\": \"\",\n \"regionID\": \"\",\n \"functionEnvironmentName\": \"\",\n \"description\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "605aaafb-067c-4c26-ba28-d2a5dfc983a5", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "verbose", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7da0b243-58f8-4589-a271-7a99309a0f23", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "verbose", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "98d16f27-eb1c-4f81-af29-87317b8d11c9", "name": "Update Function Deployment", "request": { "name": "Update Function Deployment", "description": { "content": "Updates the specified function deployment.", "type": "text/plain" }, "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a884eefb-9f9a-4b12-a765-f255be69d8e4", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionDeploymentID\": \"\",\n \"status\": \"NONE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "564f3ac1-f5cd-4f83-9443-01ce26aa7c57", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46554bc6-b776-4334-950c-9af8e1e3f7b8", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"functionEnvironmentID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09b101ed-278f-4ada-b374-018de042fd19", "name": "Get Deployment Logs", "request": { "name": "Get Deployment Logs", "description": { "content": "Return function deployment logs.", "type": "text/plain" }, "url": { "path": [ "v1", "functionDeployments", ":ID", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "methodName", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "startTime", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "aa140090-6e49-40c1-92d3-29f9289eb9f0", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "methodName", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "startTime", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"logs\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be49ee26-7139-47f4-88ac-1dfb46a3cb7c", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "methodName", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "startTime", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97d15c7a-c289-42ce-8c59-9cdace74b4a3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionDeployments", ":ID", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "methodName", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "startTime", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filter", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0aea9ef3-d37b-4107-b11d-6dcf3c788e4f", "name": "List Function Environments", "request": { "name": "List Function Environments", "description": { "content": "Returns all function environments in the account.", "type": "text/plain" }, "url": { "path": [ "v1", "functionEnvironments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.isDefault", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "044a1be6-bb95-4a88-aa69-d18ca63728c2", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.isDefault", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionEnvironments\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56e9b734-1f42-4b65-b5d5-cb5bd1716b97", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.isDefault", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f3bda48-6c33-4df9-8b10-6fadbb1d9691", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.isDefault", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f401219f-8677-4a3a-a97d-b5a6cbe0efae", "name": "Create Function Environment", "request": { "name": "Create Function Environment", "description": { "content": "Creates a new environment.", "type": "text/plain" }, "url": { "path": [ "v1", "functionEnvironments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ee5df00a-7e65-4401-869b-41de34683bf3", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionEnvironmentID\": \"\",\n \"functionEnvironmentName\": \"\",\n \"functionEnvironmentDescription\": \"\",\n \"isDefault\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56e834ae-53fd-453c-b371-8716ae1b0677", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2538b69f-343b-4eff-883d-d215e8eff148", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cfa49c6b-e1ed-4b55-8857-a98682ff885d", "name": "Delete Function Environment", "request": { "name": "Delete Function Environment", "description": { "content": "Deletes the specified function environment.", "type": "text/plain" }, "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "8f2f1bb9-5caa-428d-8fc4-0332a426c204", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63ca72b9-fb59-43af-bf90-dba99b7a5a51", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c3e9c14-1029-4b1a-9f30-afdf3c643c41", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7b96ee67-7c09-4046-8ffa-498616dd2aeb", "name": "Get Function Environment", "request": { "name": "Get Function Environment", "description": { "content": "Returns the specified function environment.", "type": "text/plain" }, "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "381aa60f-42cf-41c9-92fb-01d2330f454f", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ff8497c-4bc9-4844-8c80-1ebee7b6df50", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d86d6b6-55fb-48a4-bd20-3bc9bfbe485e", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f1961eb-443c-4d0f-8c5e-479837646b1c", "name": "Update Function Environment", "request": { "name": "Update Function Environment", "description": { "content": "Updates the specified function environment.", "type": "text/plain" }, "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e9b89ea6-96bd-4387-85f4-a52601389919", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionEnvironmentID\": \"\",\n \"functionEnvironmentName\": \"\",\n \"functionEnvironmentDescription\": \"\",\n \"isDefault\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2126c91-c702-4d0d-b283-a984b8caf927", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc38bec4-8f66-4e1e-b7f1-d1008e458f15", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"description\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ed63767-77e1-4a03-9848-cc91878a5c9c", "name": "Delete Function Environment Variable", "request": { "name": "Delete Function Environment Variable", "description": { "content": "Deletes the specified function environment variable.", "type": "text/plain" }, "url": { "path": [ "v1", "functionEnvironments", ":ID", "variable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7175cd8a-3213-42b4-94e5-cc6c151cea3a", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID", "variable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionEnvironmentID\": \"\",\n \"functionEnvironmentName\": \"\",\n \"functionEnvironmentDescription\": \"\",\n \"isDefault\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f1e021b-6873-4ab7-981b-987b1773632a", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID", "variable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2dc78c1-ef7f-4251-85f1-2bb74a866d2e", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID", "variable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99f20d18-7856-427b-adb2-bf21696daa1c", "name": "Update Function Environment Variable", "request": { "name": "Update Function Environment Variable", "description": { "content": "Updates the specified function environment variable.", "type": "text/plain" }, "url": { "path": [ "v1", "functionEnvironments", ":ID", "variable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e71119b3-3794-4fdf-bd6d-dd4d67bc14c7", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID", "variable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionEnvironmentID\": \"\",\n \"functionEnvironmentName\": \"\",\n \"functionEnvironmentDescription\": \"\",\n \"isDefault\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6588615-dee9-4077-9010-52410ececf51", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID", "variable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ead7a91-8618-4489-a4ec-d82715907783", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionEnvironments", ":ID", "variable" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "651e41a2-4684-4b74-856f-f39928bf9e4e", "name": "List All Function Tags", "request": { "name": "List All Function Tags", "description": { "content": "Returns all function tags for all accounts.", "type": "text/plain" }, "url": { "path": [ "v1", "functionTags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified tag status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.functionID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "daysToRetrieve in days for which for which we want to fetch function tags.", "type": "text/plain" }, "key": "daysToRetrieve", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "71eaddf3-ae91-43a9-83e4-a89a1e64dca9", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionTags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified tag status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.functionID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "daysToRetrieve in days for which for which we want to fetch function tags.", "type": "text/plain" }, "key": "daysToRetrieve", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionTag\": [\n {\n \"ID\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"downloadInfo\": {\n \"codeURL\": \"\",\n \"expiryTime\": \"\"\n },\n \"status\": \"INACTIVE\",\n \"handlerConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"isZipped\": \"\",\n \"dependencies\": [\n \"\",\n \"\"\n ],\n \"errorMessage\": \"\",\n \"functionName\": \"\"\n },\n {\n \"ID\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"downloadInfo\": {\n \"codeURL\": \"\",\n \"expiryTime\": \"\"\n },\n \"status\": \"PENDING\",\n \"handlerConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"isZipped\": \"\",\n \"dependencies\": [\n \"\",\n \"\"\n ],\n \"errorMessage\": \"\",\n \"functionName\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68913d41-b634-4324-b33b-dc64d5d7dc3d", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionTags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified tag status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.functionID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "daysToRetrieve in days for which for which we want to fetch function tags.", "type": "text/plain" }, "key": "daysToRetrieve", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6d2185b-df4c-49b4-b11a-cb392f03a525", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionTags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified tag status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.functionID", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "filterOps.accountID", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "daysToRetrieve in days for which for which we want to fetch function tags.", "type": "text/plain" }, "key": "daysToRetrieve", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5578ebb0-1e1d-4c94-a49d-11098d60ea65", "name": "Update Function Tag", "request": { "name": "Update Function Tag", "description": { "content": "Updates the specified function tag.", "type": "text/plain" }, "url": { "path": [ "v1", "functionTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"status\": \"ACTIVE\",\n \"message\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eef838cc-4b02-49d1-9034-91167ac43d4d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functionTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"status\": \"ACTIVE\",\n \"message\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"status\": \"PENDING\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c1d4b71-3264-4fa4-a0f9-d979e634ecda", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functionTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"status\": \"ACTIVE\",\n \"message\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae1602ec-da3c-4429-b147-ff5e2c8bd002", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functionTags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"status\": \"ACTIVE\",\n \"message\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f799a70b-c260-4666-b634-b9da1fe8a49f", "name": "List Functions", "request": { "name": "List Functions", "description": { "content": "Returns all functions in the account.", "type": "text/plain" }, "url": { "path": [ "v1", "functions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4b44c785-6f63-4166-8de6-291d42c0384f", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functions\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f5d57eb-2e55-4790-9499-024fbb0e017a", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fdea95d-5bd8-4252-99a5-01515bf7dadb", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c90a6d6-d57c-4390-887d-185e947de5cc", "name": "Create Function", "request": { "name": "Create Function", "description": { "content": "Creates a new function. Requires the INTEROP role.", "type": "text/plain" }, "url": { "path": [ "v1", "functions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"functionConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"functionDeployment\": {\n \"deploy\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\",\n \"functionDeploymentName\": \"\",\n \"functionDeploymentDescription\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"dependencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f001cc93-9578-4ee3-9f4f-6967c64e642d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"functionConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"functionDeployment\": {\n \"deploy\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\",\n \"functionDeploymentName\": \"\",\n \"functionDeploymentDescription\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"dependencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"versionTag\": \"\",\n \"deploymentID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "283ea177-2d55-42ce-bb4d-26a8f564a3e5", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"functionConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"functionDeployment\": {\n \"deploy\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\",\n \"functionDeploymentName\": \"\",\n \"functionDeploymentDescription\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"dependencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "863c41cd-02b1-43c9-ba38-6d7c45b20029", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"functionConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"functionDeployment\": {\n \"deploy\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\",\n \"functionDeploymentName\": \"\",\n \"functionDeploymentDescription\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"dependencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77ff457c-cf70-4c53-8585-8e71955dfec9", "name": "Delete Function", "request": { "name": "Delete Function", "description": { "content": "Deletes the specified function.", "type": "text/plain" }, "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d78bd397-0ae2-4551-8cc6-ef2079199be2", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f6a4836-1578-471e-8264-100df09c2561", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e2fe082-5fb6-417d-949a-d46ea7ad393c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0784c45-f005-4853-a135-08c9b9dc43e3", "name": "Get Function", "request": { "name": "Get Function", "description": { "content": "Returns the specified function.", "type": "text/plain" }, "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1c2bdb8a-cee9-4c5e-958c-c03667fa1bee", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f877cd4-e4a2-407c-bc74-84082bfb07c3", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fb38a92-f234-4cc1-a19b-f47454252cce", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "835e358d-afa3-4ae8-930e-568fddf3afeb", "name": "Update Function", "request": { "name": "Update Function", "description": { "content": "Updates the specified function.", "type": "text/plain" }, "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"functionConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"functionDeployment\": {\n \"deploy\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\",\n \"functionDeploymentName\": \"\",\n \"functionDeploymentDescription\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"dependencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fede5ba6-d5ad-40b9-ae2e-edf6836cf6fe", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"functionConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"functionDeployment\": {\n \"deploy\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\",\n \"functionDeploymentName\": \"\",\n \"functionDeploymentDescription\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"dependencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"versionTag\": \"\",\n \"deploymentID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f57ef4ea-35f1-4eee-83e6-2b355c8bffef", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"functionConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"functionDeployment\": {\n \"deploy\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\",\n \"functionDeploymentName\": \"\",\n \"functionDeploymentDescription\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"dependencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6b3e4a6-7089-4b63-82a9-1db29def46fa", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"code\": \"\",\n \"functionConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"functionDeployment\": {\n \"deploy\": \"\",\n \"functionEnvironmentID\": \"\",\n \"regionID\": \"\",\n \"functionDeploymentName\": \"\",\n \"functionDeploymentDescription\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"dependencies\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d70b561-a8b4-4c8a-a7d6-10604ba0b799", "name": "List Function Tags", "request": { "name": "List Function Tags", "description": { "content": "Returns all tags for the specified function.", "type": "text/plain" }, "url": { "path": [ "v1", "functions", ":ID", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified tag status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6086570c-32e5-416b-beab-f2f4606bc356", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified tag status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"functionID\": \"\",\n \"functionName\": \"\",\n \"tags\": [\n {\n \"ID\": \"\",\n \"versionTag\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"isZipped\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"ID\": \"\",\n \"versionTag\": \"\",\n \"status\": \"PENDING\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"isZipped\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf0c4735-eeb0-4e31-b4b3-d92e9cabcec9", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified tag status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62371ea1-ae4d-40be-88ba-c4c90999ba40", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified tag status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e454a4ef-7f22-42c6-af58-de9238faacbf", "name": "Get Function Tag", "request": { "name": "Get Function Tag", "description": { "content": "Returns the specified function tag.", "type": "text/plain" }, "url": { "path": [ "v1", "functions", ":ID", "tags", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "versionTag", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "07b9dce8-6e89-45d4-babe-9e6e77e5634b", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID", "tags", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\",\n \"functionID\": \"\",\n \"versionTag\": \"\",\n \"downloadInfo\": {\n \"codeURL\": \"\",\n \"expiryTime\": \"\"\n },\n \"status\": \"NONE\",\n \"handlerConfigs\": [\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n },\n {\n \"handlerName\": \"\",\n \"methodName\": \"\",\n \"variables\": [\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"NONE\"\n }\n ],\n \"resourceConfig\": {\n \"timeout\": \"\",\n \"memory\": \"\"\n },\n \"numberOfWarmInstances\": \"\"\n }\n ],\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"language\": {\n \"languageName\": \"LANGUAGE_NOT_DEFINED\",\n \"languageVersion\": \"\"\n },\n \"isZipped\": \"\",\n \"dependencies\": [\n \"\",\n \"\"\n ],\n \"errorMessage\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af14ae4a-da3c-46e1-b4d7-f9c36204954a", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID", "tags", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9a7549e-ebcc-4704-a690-12ce7a5ce999", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "functions", ":ID", "tags", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "downloadURL", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Key Management", "description": "", "item": [ { "id": "0c1edb7a-dde2-4006-a4b8-2151b0448f62", "name": "Get Cloud Provider Details", "request": { "name": "Get Cloud Provider Details", "description": { "content": "Gets details of cloud providers for key management workflows.", "type": "text/plain" }, "url": { "path": [ "v1", "cloudProviders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fb1568bc-1613-4723-b513-a5e8186ca5b8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "cloudProviders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"cloudProvider\": \"GCP\",\n \"accountNumber\": \"\",\n \"primaryRegion\": \"\",\n \"replicaRegion\": \"\",\n \"cryptoUserResourceName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84d9d691-adbe-4e6c-8eec-6ff954d5a04e", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "cloudProviders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c9d8763-b220-4580-b419-3456de702f48", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "cloudProviders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b8a5287-249c-4b9f-a6c2-fe28bd3d13c2", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "cloudProviders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e0352bd-f9bf-4c13-a9cd-aba2baaacdf2", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "cloudProviders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0eaddfe-7073-472b-8ff7-45bc9afc1c66", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "cloudProviders" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5835b0d5-4f5d-4ea6-8679-06d8a9648412", "name": "Get Master Key Import Parameters", "request": { "name": "Get Master Key Import Parameters", "description": { "content": "Gets parameters to import an external master key into a workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "masterKeys", "getImportParams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c61ce9ef-dda3-403c-8d13-57f50feaa66e", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "getImportParams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"publicKey\": \"\",\n \"region\": \"\",\n \"importToken\": \"\",\n \"importJobID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c9cfc69-63da-4038-bd17-2cf662bb5532", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "getImportParams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11c469f2-e45d-4f87-98aa-1b2d8f39140c", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "getImportParams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0fe1890-b38f-4847-87a2-9c6b4e216871", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "getImportParams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "049ccf19-2871-45e7-ba7d-42cf7012a7e6", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "getImportParams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60f684c7-16ca-47a7-92a9-43b7b85adbf2", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "getImportParams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "key": "workspaceID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2eec0f3-030a-424e-a161-a5e5577c23e1", "name": "Import Master Key", "request": { "name": "Import Master Key", "description": { "content": "Imports external master key ciphertext into a workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "masterKeys", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ciphertext\": \"\",\n \"importParams\": {\n \"publicKey\": \"\",\n \"region\": \"\",\n \"importToken\": \"\",\n \"importJobID\": \"\"\n },\n \"workspaceID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "2a6553c0-9b1e-47a6-a348-cfaaae2f946e", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ciphertext\": \"\",\n \"importParams\": {\n \"publicKey\": \"\",\n \"region\": \"\",\n \"importToken\": \"\",\n \"importJobID\": \"\"\n },\n \"workspaceID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49234e57-8a3e-402a-ba23-d39e99899aa4", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ciphertext\": \"\",\n \"importParams\": {\n \"publicKey\": \"\",\n \"region\": \"\",\n \"importToken\": \"\",\n \"importJobID\": \"\"\n },\n \"workspaceID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20d98dc2-ada5-4842-8c52-b68c5f32d5db", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ciphertext\": \"\",\n \"importParams\": {\n \"publicKey\": \"\",\n \"region\": \"\",\n \"importToken\": \"\",\n \"importJobID\": \"\"\n },\n \"workspaceID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6d1b5f8-94ee-470f-a688-c8ba01be46bb", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ciphertext\": \"\",\n \"importParams\": {\n \"publicKey\": \"\",\n \"region\": \"\",\n \"importToken\": \"\",\n \"importJobID\": \"\"\n },\n \"workspaceID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a8ad94c-73d5-479a-82ea-8a75ef7ec1aa", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ciphertext\": \"\",\n \"importParams\": {\n \"publicKey\": \"\",\n \"region\": \"\",\n \"importToken\": \"\",\n \"importJobID\": \"\"\n },\n \"workspaceID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d4f5b04-c3f5-4f63-bf59-2706cee46c77", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ciphertext\": \"\",\n \"importParams\": {\n \"publicKey\": \"\",\n \"region\": \"\",\n \"importToken\": \"\",\n \"importJobID\": \"\"\n },\n \"workspaceID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0576b7ab-152d-4b3c-9290-08ac0fb38f15", "name": "Get Master Key Metadata", "request": { "name": "Get Master Key Metadata", "description": { "content": "Gets metadata associated with a vault's master key.", "type": "text/plain" }, "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "getMasterKeyMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6dcb3c33-c4f4-40d4-a3d8-4bac52d6cb65", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "getMasterKeyMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"createdAt\": \"\",\n \"expiresAt\": \"\",\n \"alertAt\": \"\",\n \"rotationPendingWindowInDays\": \"\",\n \"type\": \"INTERNAL\",\n \"origin\": \"GCP_KMS\",\n \"id\": \"\",\n \"isRotationInProgress\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a2d6650-b990-4c8c-8c8f-db26950a5c5c", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "getMasterKeyMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69006dc9-68be-4070-89e9-3ba1dc976c75", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "getMasterKeyMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f38db34c-db95-4d51-9fe2-7abe2f500b1d", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "getMasterKeyMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7942479b-5130-4a41-b7e8-d6a3da26ad09", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "getMasterKeyMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f27069a3-de23-40ce-87f4-5081530ae70e", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "getMasterKeyMetadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b8ce342-577c-4847-8490-233e7411ecc4", "name": "Rotate Master Key", "request": { "name": "Rotate Master Key", "description": { "content": "Rotates a vault's master key.", "type": "text/plain" }, "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"masterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"pendingWindowInDays\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7d51a853-ce93-47ca-bb08-bfa8de4ece44", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"masterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"pendingWindowInDays\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"status\": \"DONE\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b46267be-83f8-4866-a379-94994314d518", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"masterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"pendingWindowInDays\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2adf867-35af-41be-9836-765372a66e63", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"masterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"pendingWindowInDays\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0783a50d-c7fa-4c4e-a3b1-a55f936512c2", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"masterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"pendingWindowInDays\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d00615be-712a-4664-b61e-e3b704b55e12", "name": "Returned when there is a conflict with the current state of the target resource.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"masterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"pendingWindowInDays\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1c5bc96-e593-430f-821f-0cc486498d6d", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"masterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"pendingWindowInDays\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00eef635-1b01-4d37-8d0c-d76eac3d7298", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "masterKeys", "vaults", ":vaultID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"workspaceID\": \"\",\n \"vaultID\": \"\",\n \"masterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"pendingWindowInDays\": 0\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Roles", "description": "", "item": [ { "id": "b2207df4-f624-4daf-b774-fe660106a0fb", "name": "List Permissions of Member", "request": { "name": "List Permissions of Member", "description": { "content": "Lists permissions assigned to a member.", "type": "text/plain" }, "url": { "path": [ "v1", "members", ":member.ID", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "member.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the member.", "type": "text/plain" }, "key": "member.name", "value": "" }, { "disabled": true, "description": { "content": "Email address of the member.", "type": "text/plain" }, "key": "member.email", "value": "" }, { "disabled": true, "description": { "content": "Status of the member. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the user.", "type": "text/plain" }, "key": "member.user.name", "value": "" }, { "disabled": true, "description": { "content": "Address number and street name.", "type": "text/plain" }, "key": "member.user.contactAddress.streetAddress", "value": "" }, { "disabled": true, "description": { "content": "City.", "type": "text/plain" }, "key": "member.user.contactAddress.city", "value": "" }, { "disabled": true, "description": { "content": "State or province.", "type": "text/plain" }, "key": "member.user.contactAddress.state", "value": "" }, { "disabled": true, "description": { "content": "Country.", "type": "text/plain" }, "key": "member.user.contactAddress.country", "value": "" }, { "disabled": true, "description": { "content": "Postal code.", "type": "text/plain" }, "key": "member.user.contactAddress.zip", "value": "" }, { "disabled": true, "description": { "content": "Email address of the user.", "type": "text/plain" }, "key": "member.user.userIdentity.email", "value": "" }, { "disabled": true, "description": { "content": "Okta ID of the user.", "type": "text/plain" }, "key": "member.user.userIdentity.oktaID", "value": "" }, { "disabled": true, "description": { "content": "ID of the user. Generated by Skyflow.", "type": "text/plain" }, "key": "member.user.ID", "value": "" }, { "disabled": true, "description": { "content": "Status of the user. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.user.status", "value": "NONE" }, { "disabled": true, "description": { "content": "User who created the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.CreatedBy", "value": "" }, { "disabled": true, "description": { "content": "User who last modified the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.LastModifiedBy", "value": "" }, { "disabled": true, "description": { "content": "Creation time of the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.CreatedOn", "value": "" }, { "disabled": true, "description": { "content": "Last modification time of the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.LastModifiedOn", "value": "" }, { "disabled": true, "description": { "content": "Name of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.name", "value": "" }, { "disabled": true, "description": { "content": "Display name of the service account that appears in user interfaces.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.displayName", "value": "" }, { "disabled": true, "description": { "content": "Description of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.description", "value": "" }, { "disabled": true, "description": { "content": "ID of the service account. Generated by Skyflow.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.ID", "value": "" }, { "disabled": true, "description": { "content": "Namespace of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.namespace", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.status", "value": "NONE" }, { "disabled": true, "description": { "content": "User who created the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedBy", "value": "" }, { "disabled": true, "description": { "content": "User who last modified the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedBy", "value": "" }, { "disabled": true, "description": { "content": "Creation time of the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedOn", "value": "" }, { "disabled": true, "description": { "content": "Last modification time of the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedOn", "value": "" }, { "disabled": true, "description": { "content": "When `true`, all JWT assertions for this service account much contain a `ctx` claim.", "type": "text/plain" }, "key": "member.serviceAccountInfo.clientConfiguration.enforceContextID", "value": "" }, { "disabled": true, "description": { "content": "When `true`, all data tokens sent to the vault using this service account must be signed with the associated private key.", "type": "text/plain" }, "key": "member.serviceAccountInfo.clientConfiguration.enforceSignedDataTokens", "value": "" } ], "variable": [ { "type": "any", "key": "member" }, { "disabled": false, "description": { "content": "(Required) ID of the member.", "type": "text/plain" }, "type": "any", "value": "", "key": "member.ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cb00a6a8-1a24-48ac-bce6-205012ea7a4a", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "members", ":member.ID", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "member.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the member.", "type": "text/plain" }, "key": "member.name", "value": "" }, { "disabled": true, "description": { "content": "Email address of the member.", "type": "text/plain" }, "key": "member.email", "value": "" }, { "disabled": true, "description": { "content": "Status of the member. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the user.", "type": "text/plain" }, "key": "member.user.name", "value": "" }, { "disabled": true, "description": { "content": "Address number and street name.", "type": "text/plain" }, "key": "member.user.contactAddress.streetAddress", "value": "" }, { "disabled": true, "description": { "content": "City.", "type": "text/plain" }, "key": "member.user.contactAddress.city", "value": "" }, { "disabled": true, "description": { "content": "State or province.", "type": "text/plain" }, "key": "member.user.contactAddress.state", "value": "" }, { "disabled": true, "description": { "content": "Country.", "type": "text/plain" }, "key": "member.user.contactAddress.country", "value": "" }, { "disabled": true, "description": { "content": "Postal code.", "type": "text/plain" }, "key": "member.user.contactAddress.zip", "value": "" }, { "disabled": true, "description": { "content": "Email address of the user.", "type": "text/plain" }, "key": "member.user.userIdentity.email", "value": "" }, { "disabled": true, "description": { "content": "Okta ID of the user.", "type": "text/plain" }, "key": "member.user.userIdentity.oktaID", "value": "" }, { "disabled": true, "description": { "content": "ID of the user. Generated by Skyflow.", "type": "text/plain" }, "key": "member.user.ID", "value": "" }, { "disabled": true, "description": { "content": "Status of the user. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.user.status", "value": "NONE" }, { "disabled": true, "description": { "content": "User who created the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.CreatedBy", "value": "" }, { "disabled": true, "description": { "content": "User who last modified the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.LastModifiedBy", "value": "" }, { "disabled": true, "description": { "content": "Creation time of the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.CreatedOn", "value": "" }, { "disabled": true, "description": { "content": "Last modification time of the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.LastModifiedOn", "value": "" }, { "disabled": true, "description": { "content": "Name of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.name", "value": "" }, { "disabled": true, "description": { "content": "Display name of the service account that appears in user interfaces.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.displayName", "value": "" }, { "disabled": true, "description": { "content": "Description of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.description", "value": "" }, { "disabled": true, "description": { "content": "ID of the service account. Generated by Skyflow.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.ID", "value": "" }, { "disabled": true, "description": { "content": "Namespace of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.namespace", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.status", "value": "NONE" }, { "disabled": true, "description": { "content": "User who created the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedBy", "value": "" }, { "disabled": true, "description": { "content": "User who last modified the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedBy", "value": "" }, { "disabled": true, "description": { "content": "Creation time of the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedOn", "value": "" }, { "disabled": true, "description": { "content": "Last modification time of the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedOn", "value": "" }, { "disabled": true, "description": { "content": "When `true`, all JWT assertions for this service account much contain a `ctx` claim.", "type": "text/plain" }, "key": "member.serviceAccountInfo.clientConfiguration.enforceContextID", "value": "" }, { "disabled": true, "description": { "content": "When `true`, all data tokens sent to the vault using this service account must be signed with the associated private key.", "type": "text/plain" }, "key": "member.serviceAccountInfo.clientConfiguration.enforceSignedDataTokens", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the member.", "type": "text/plain" }, "type": "any", "value": "", "key": "member.ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"permissions\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "472fdd14-199d-4969-8382-2fdb15f70127", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "members", ":member.ID", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "member.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the member.", "type": "text/plain" }, "key": "member.name", "value": "" }, { "disabled": true, "description": { "content": "Email address of the member.", "type": "text/plain" }, "key": "member.email", "value": "" }, { "disabled": true, "description": { "content": "Status of the member. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the user.", "type": "text/plain" }, "key": "member.user.name", "value": "" }, { "disabled": true, "description": { "content": "Address number and street name.", "type": "text/plain" }, "key": "member.user.contactAddress.streetAddress", "value": "" }, { "disabled": true, "description": { "content": "City.", "type": "text/plain" }, "key": "member.user.contactAddress.city", "value": "" }, { "disabled": true, "description": { "content": "State or province.", "type": "text/plain" }, "key": "member.user.contactAddress.state", "value": "" }, { "disabled": true, "description": { "content": "Country.", "type": "text/plain" }, "key": "member.user.contactAddress.country", "value": "" }, { "disabled": true, "description": { "content": "Postal code.", "type": "text/plain" }, "key": "member.user.contactAddress.zip", "value": "" }, { "disabled": true, "description": { "content": "Email address of the user.", "type": "text/plain" }, "key": "member.user.userIdentity.email", "value": "" }, { "disabled": true, "description": { "content": "Okta ID of the user.", "type": "text/plain" }, "key": "member.user.userIdentity.oktaID", "value": "" }, { "disabled": true, "description": { "content": "ID of the user. Generated by Skyflow.", "type": "text/plain" }, "key": "member.user.ID", "value": "" }, { "disabled": true, "description": { "content": "Status of the user. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.user.status", "value": "NONE" }, { "disabled": true, "description": { "content": "User who created the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.CreatedBy", "value": "" }, { "disabled": true, "description": { "content": "User who last modified the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.LastModifiedBy", "value": "" }, { "disabled": true, "description": { "content": "Creation time of the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.CreatedOn", "value": "" }, { "disabled": true, "description": { "content": "Last modification time of the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.LastModifiedOn", "value": "" }, { "disabled": true, "description": { "content": "Name of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.name", "value": "" }, { "disabled": true, "description": { "content": "Display name of the service account that appears in user interfaces.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.displayName", "value": "" }, { "disabled": true, "description": { "content": "Description of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.description", "value": "" }, { "disabled": true, "description": { "content": "ID of the service account. Generated by Skyflow.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.ID", "value": "" }, { "disabled": true, "description": { "content": "Namespace of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.namespace", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.status", "value": "NONE" }, { "disabled": true, "description": { "content": "User who created the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedBy", "value": "" }, { "disabled": true, "description": { "content": "User who last modified the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedBy", "value": "" }, { "disabled": true, "description": { "content": "Creation time of the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedOn", "value": "" }, { "disabled": true, "description": { "content": "Last modification time of the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedOn", "value": "" }, { "disabled": true, "description": { "content": "When `true`, all JWT assertions for this service account much contain a `ctx` claim.", "type": "text/plain" }, "key": "member.serviceAccountInfo.clientConfiguration.enforceContextID", "value": "" }, { "disabled": true, "description": { "content": "When `true`, all data tokens sent to the vault using this service account must be signed with the associated private key.", "type": "text/plain" }, "key": "member.serviceAccountInfo.clientConfiguration.enforceSignedDataTokens", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the member.", "type": "text/plain" }, "type": "any", "value": "", "key": "member.ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d83fbb15-a6e1-4d6d-b204-513d70d6ba50", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "members", ":member.ID", "permissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "member.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the member.", "type": "text/plain" }, "key": "member.name", "value": "" }, { "disabled": true, "description": { "content": "Email address of the member.", "type": "text/plain" }, "key": "member.email", "value": "" }, { "disabled": true, "description": { "content": "Status of the member. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the user.", "type": "text/plain" }, "key": "member.user.name", "value": "" }, { "disabled": true, "description": { "content": "Address number and street name.", "type": "text/plain" }, "key": "member.user.contactAddress.streetAddress", "value": "" }, { "disabled": true, "description": { "content": "City.", "type": "text/plain" }, "key": "member.user.contactAddress.city", "value": "" }, { "disabled": true, "description": { "content": "State or province.", "type": "text/plain" }, "key": "member.user.contactAddress.state", "value": "" }, { "disabled": true, "description": { "content": "Country.", "type": "text/plain" }, "key": "member.user.contactAddress.country", "value": "" }, { "disabled": true, "description": { "content": "Postal code.", "type": "text/plain" }, "key": "member.user.contactAddress.zip", "value": "" }, { "disabled": true, "description": { "content": "Email address of the user.", "type": "text/plain" }, "key": "member.user.userIdentity.email", "value": "" }, { "disabled": true, "description": { "content": "Okta ID of the user.", "type": "text/plain" }, "key": "member.user.userIdentity.oktaID", "value": "" }, { "disabled": true, "description": { "content": "ID of the user. Generated by Skyflow.", "type": "text/plain" }, "key": "member.user.ID", "value": "" }, { "disabled": true, "description": { "content": "Status of the user. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.user.status", "value": "NONE" }, { "disabled": true, "description": { "content": "User who created the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.CreatedBy", "value": "" }, { "disabled": true, "description": { "content": "User who last modified the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.LastModifiedBy", "value": "" }, { "disabled": true, "description": { "content": "Creation time of the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.CreatedOn", "value": "" }, { "disabled": true, "description": { "content": "Last modification time of the resource.", "type": "text/plain" }, "key": "member.user.BasicAudit.LastModifiedOn", "value": "" }, { "disabled": true, "description": { "content": "Name of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.name", "value": "" }, { "disabled": true, "description": { "content": "Display name of the service account that appears in user interfaces.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.displayName", "value": "" }, { "disabled": true, "description": { "content": "Description of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.description", "value": "" }, { "disabled": true, "description": { "content": "ID of the service account. Generated by Skyflow.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.ID", "value": "" }, { "disabled": true, "description": { "content": "Namespace of the service account.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.namespace", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.status", "value": "NONE" }, { "disabled": true, "description": { "content": "User who created the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedBy", "value": "" }, { "disabled": true, "description": { "content": "User who last modified the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedBy", "value": "" }, { "disabled": true, "description": { "content": "Creation time of the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.CreatedOn", "value": "" }, { "disabled": true, "description": { "content": "Last modification time of the resource.", "type": "text/plain" }, "key": "member.serviceAccountInfo.serviceAccount.BasicAudit.LastModifiedOn", "value": "" }, { "disabled": true, "description": { "content": "When `true`, all JWT assertions for this service account much contain a `ctx` claim.", "type": "text/plain" }, "key": "member.serviceAccountInfo.clientConfiguration.enforceContextID", "value": "" }, { "disabled": true, "description": { "content": "When `true`, all data tokens sent to the vault using this service account must be signed with the associated private key.", "type": "text/plain" }, "key": "member.serviceAccountInfo.clientConfiguration.enforceSignedDataTokens", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the member.", "type": "text/plain" }, "type": "any", "value": "", "key": "member.ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "09338096-531d-41ab-9bca-657f8367570a", "name": "List Roles of Member", "request": { "name": "List Roles of Member", "description": { "content": "Lists roles assigned to a member as role-to-resource pairs.", "type": "text/plain" }, "url": { "path": [ "v1", "members", ":member.ID", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "member.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the member.", "type": "text/plain" }, "key": "member.name", "value": "" }, { "disabled": true, "description": { "content": "Email address of the member.", "type": "text/plain" }, "key": "member.email", "value": "" }, { "disabled": true, "description": { "content": "Status of the member. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "filterOps.resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "filterOps.resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "filterOps.resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "filterOps.resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "filterOps.resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "filterOps.resource.displayName", "value": "" }, { "disabled": true, "description": { "content": " - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user. (This can only be one of NONE,SYSTEM,CUSTOM)", "type": "text/plain" }, "key": "filterOps.roleType", "value": "NONE" } ], "variable": [ { "type": "any", "key": "member" }, { "disabled": false, "description": { "content": "(Required) ID of the member.", "type": "text/plain" }, "type": "any", "value": "", "key": "member.ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "24623050-aa4f-4ea3-88dd-6d7fe988fb2f", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "members", ":member.ID", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "member.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the member.", "type": "text/plain" }, "key": "member.name", "value": "" }, { "disabled": true, "description": { "content": "Email address of the member.", "type": "text/plain" }, "key": "member.email", "value": "" }, { "disabled": true, "description": { "content": "Status of the member. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "filterOps.resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "filterOps.resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "filterOps.resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "filterOps.resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "filterOps.resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "filterOps.resource.displayName", "value": "" }, { "disabled": true, "description": { "content": " - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user. (This can only be one of NONE,SYSTEM,CUSTOM)", "type": "text/plain" }, "key": "filterOps.roleType", "value": "NONE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the member.", "type": "text/plain" }, "type": "any", "value": "", "key": "member.ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"roleToResource\": [\n {\n \"role\": {\n \"ID\": \"\",\n \"namespace\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n },\n {\n \"role\": {\n \"ID\": \"\",\n \"namespace\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f30e9b00-7f6b-4288-81cc-a1f8d6fe4345", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "members", ":member.ID", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "member.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the member.", "type": "text/plain" }, "key": "member.name", "value": "" }, { "disabled": true, "description": { "content": "Email address of the member.", "type": "text/plain" }, "key": "member.email", "value": "" }, { "disabled": true, "description": { "content": "Status of the member. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "filterOps.resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "filterOps.resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "filterOps.resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "filterOps.resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "filterOps.resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "filterOps.resource.displayName", "value": "" }, { "disabled": true, "description": { "content": " - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user. (This can only be one of NONE,SYSTEM,CUSTOM)", "type": "text/plain" }, "key": "filterOps.roleType", "value": "NONE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the member.", "type": "text/plain" }, "type": "any", "value": "", "key": "member.ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0e4f636-2894-4d27-a534-b382977b54f8", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "members", ":member.ID", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "member.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the member.", "type": "text/plain" }, "key": "member.name", "value": "" }, { "disabled": true, "description": { "content": "Email address of the member.", "type": "text/plain" }, "key": "member.email", "value": "" }, { "disabled": true, "description": { "content": "Status of the member. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "member.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "filterOps.resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "filterOps.resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "filterOps.resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "filterOps.resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "filterOps.resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "filterOps.resource.displayName", "value": "" }, { "disabled": true, "description": { "content": " - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user. (This can only be one of NONE,SYSTEM,CUSTOM)", "type": "text/plain" }, "key": "filterOps.roleType", "value": "NONE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the member.", "type": "text/plain" }, "type": "any", "value": "", "key": "member.ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a67de027-7cae-4cb2-8207-2a32c35d0911", "name": "List Roles of Policy", "request": { "name": "List Roles of Policy", "description": { "content": "Lists roles assigned to a policy.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", ":policyID", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified role name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "type": "any", "value": "", "key": "policyID", "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6ad144b2-7e0b-4fc0-a862-2b9723b19c35", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":policyID", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified role name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "policyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"roles\": [\n {\n \"ID\": \"\",\n \"namespace\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n {\n \"ID\": \"\",\n \"namespace\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fecc04e-2a7c-4d5c-9c01-a6ded105ff43", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", ":policyID", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified role name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "policyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c086f184-8c86-450a-b8fd-c5d907955817", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":policyID", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified role name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "policyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46bdd292-680d-4ced-9a99-91ec4d3ab69a", "name": "List Skyflow-defined Roles", "request": { "name": "List Skyflow-defined Roles", "description": { "content": "Lists Skyflow-defined roles. You can't update or delete these roles.", "type": "text/plain" }, "url": { "path": [ "v1", "roleDefinitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,FUNCTION_CONFIG,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resourceType", "value": "NONE" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "034130a6-cb83-45ae-9ae1-195da4c7aca3", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roleDefinitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,FUNCTION_CONFIG,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resourceType", "value": "NONE" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"roleDefinitions\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92305c27-266e-48af-9ff9-6bdf2e01e90f", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roleDefinitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,FUNCTION_CONFIG,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resourceType", "value": "NONE" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1de96388-2003-43a5-96ab-5654f0931f3c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roleDefinitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,FUNCTION_CONFIG,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resourceType", "value": "NONE" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba8b00bb-f7c5-45f2-9c0b-07dbb87102f2", "name": "List Roles", "request": { "name": "List Roles", "description": { "content": "Lists roles associated with a resource.", "type": "text/plain" }, "url": { "path": [ "v1", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type.\n\n - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user. (This can only be one of NONE,SYSTEM,CUSTOM)", "type": "text/plain" }, "key": "type", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "37435491-674c-4170-bb6a-06a69d13a42b", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type.\n\n - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user. (This can only be one of NONE,SYSTEM,CUSTOM)", "type": "text/plain" }, "key": "type", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"roles\": [\n {\n \"ID\": \"\",\n \"namespace\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n {\n \"ID\": \"\",\n \"namespace\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a50af99-8296-48b0-9e91-15d610cd09f2", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type.\n\n - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user. (This can only be one of NONE,SYSTEM,CUSTOM)", "type": "text/plain" }, "key": "type", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12c80b2f-f258-434c-bf4a-b77992bf49e2", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type.\n\n - SYSTEM: Defined by Skyflow.\n - CUSTOM: Defined by a user. (This can only be one of NONE,SYSTEM,CUSTOM)", "type": "text/plain" }, "key": "type", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49af8a98-641e-4ec2-946c-2edf9289b3b8", "name": "Create Role", "request": { "name": "Create Role", "description": { "content": "Creates a custom role for the specified resource. After you create a role, you need to assign the role to a user or service account.", "type": "text/plain" }, "url": { "path": [ "v1", "roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"roleDefinition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "0b68ad25-40ee-4e39-ab50-82ae1686b579", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"roleDefinition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62ef2d4c-5f8a-40d9-85b1-2f145c5c9c7a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"roleDefinition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9edff8ea-c0b6-4d0f-8d37-69d939744ba3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"roleDefinition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e2801cf-e1be-4a5b-800c-68e597ec700d", "name": "Assign Role", "request": { "name": "Assign Role", "description": { "content": "Assigns a role to a member.", "type": "text/plain" }, "url": { "path": [ "v1", "roles", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ],\n \"condition\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f9999886-d60c-4c12-b826-728ec5febef5", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ],\n \"condition\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "567c577c-7505-4a66-960c-c9ac2b860c30", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ],\n \"condition\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3bc2484-6251-4fe6-8dc3-975e536375a5", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ],\n \"condition\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ab3e437-49f2-453e-9122-3a67be826018", "name": "Unassign Role", "request": { "name": "Unassign Role", "description": { "content": "Removes a role from members.", "type": "text/plain" }, "url": { "path": [ "v1", "roles", "unassign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eb30f273-1d14-4f3a-bcb8-3f13832fb65f", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles", "unassign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26ab0235-062b-480e-8d5d-9fba1dc7de87", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles", "unassign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bd9012b-dd18-43cb-9025-afe9065a4be2", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles", "unassign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "61eb913b-f0da-424e-8ba1-f3a94b6c3892", "name": "Delete Role", "request": { "name": "Delete Role", "description": { "content": "Deletes a custom role. Attempting to delete Skyflow-defined roles results in an error.", "type": "text/plain" }, "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "e53f447a-23d2-4e98-938d-9b4af1b0a20f", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a53148d-d9aa-431c-bef1-a02ad079773a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001813b5-fbf8-46f2-b8a3-e4c5b242a951", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5fafea4e-a4a7-4d64-8ea0-47a899f8c15d", "name": "Get Role", "request": { "name": "Get Role", "description": { "content": "Returns the specified role.", "type": "text/plain" }, "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3161b5f6-49f2-47ec-b974-3fc5ef8f6cda", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"role\": {\n \"ID\": \"\",\n \"namespace\": \"\",\n \"definition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e788ae7c-aa49-4927-a06a-33fb0f2f4a4d", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ed6cab3-9b95-4119-8019-c0e006402fff", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99567849-ac38-4e20-8f94-525e39116f5e", "name": "Update Role", "request": { "name": "Update Role", "description": { "content": "Updates a custom role. Attempting to update Skyflow-defined roles results in an error.", "type": "text/plain" }, "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"roleDefinition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1e60b244-20bd-4a7b-b76f-b55c0e24dbd4", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"roleDefinition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "149dce9d-24b7-4559-a876-325c3cfb4a99", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"roleDefinition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4baaafb-8749-4ec2-9dd8-0103d54edef2", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"roleDefinition\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"levels\": [\n \"\",\n \"\"\n ],\n \"type\": \"NONE\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01a1cc72-9bc8-4ccf-8656-2796c0120478", "name": "List Members by Role", "request": { "name": "List Members by Role", "description": { "content": "Lists members that are assign the specified role.", "type": "text/plain" }, "url": { "path": [ "v1", "roles", ":ID", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f1194b2e-97e4-42e9-8241-a1ee30a4a765", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e35e0bfb-0972-497f-8062-6087ef293531", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac879fb3-b299-499d-9b81-3c5283a74316", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":ID", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Pipelines", "description": "", "item": [ { "id": "24d3e774-6515-4e6b-b5fe-ff09852e71fe", "name": "List Pipeline Encryption Key", "request": { "name": "List Pipeline Encryption Key", "description": { "content": "Gets public encryption keys for the specified account.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "accountID", "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "341fb5ff-5baa-4d5f-9eeb-dbbb3f4c6b86", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"encryptionKeys\": [\n {\n \"ID\": \"\",\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"publicKey\": \"\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\",\n \"hasPrivateKey\": \"\"\n },\n {\n \"ID\": \"\",\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"publicKey\": \"\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\",\n \"hasPrivateKey\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31bb5803-72a4-4851-ac5d-367d3c4f0d5e", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77e67114-0750-4e5a-8d51-abe249eceed8", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90429802-1d9a-4173-b597-63dad85a8034", "name": "Create Pipeline Encryption Key", "request": { "name": "Create Pipeline Encryption Key", "description": { "content": "Creates a PGP encryption key to use in a pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "accountID", "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"pgpKey\": {\n \"privateKey\": \"\",\n \"passphrase\": \"\",\n \"publicKey\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "81e3d580-933d-4205-b34e-b6c6e6b8ec3e", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"pgpKey\": {\n \"privateKey\": \"\",\n \"passphrase\": \"\",\n \"publicKey\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"publicKey\": \"\",\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\",\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ba17a21-5aa8-4a3b-93c4-31e407dcf37b", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"pgpKey\": {\n \"privateKey\": \"\",\n \"passphrase\": \"\",\n \"publicKey\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a0b2690-5562-4f5d-861f-e1daabc49b4d", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"pgpKey\": {\n \"privateKey\": \"\",\n \"passphrase\": \"\",\n \"publicKey\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dba85e1a-6a68-4a5a-b85a-cdd3ba08a632", "name": "Delete Pipeline Encryption Key", "request": { "name": "Delete Pipeline Encryption Key", "description": { "content": "Deletes the encryption key pair for the specified pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "accountID", "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "23f12358-0cab-4029-bd41-f1f8bb0497c6", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47aa44ca-d1e2-4786-a9e7-dce88c068caf", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1beb97da-eab0-4001-8a13-530732c86d20", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cd0cd955-35ed-4912-9f47-0660ff083cd2", "name": "Get Pipeline Encryption Key", "request": { "name": "Get Pipeline Encryption Key", "description": { "content": "Gets the specified public encryption key.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "accountID", "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "da50bc17-6020-4e85-be9d-15d4606c80e0", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"publicKey\": \"\",\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\",\n \"hasPrivateKey\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8862ded8-6da7-4756-83f8-8250cb8e1ecb", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffb9760b-eb8c-4153-b890-9088e303948b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bbfae00-a23b-4fbe-9892-6957a409a32d", "name": "Rotate Pipeline Encryption Key", "request": { "name": "Rotate Pipeline Encryption Key", "description": { "content": "Rotates the encryption key pair for the specified pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "accountID", "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"pgpKey\": {\n \"privateKey\": \"\",\n \"passphrase\": \"\",\n \"publicKey\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "c7210c18-ecba-4d36-9341-383f9ca9b659", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"pgpKey\": {\n \"privateKey\": \"\",\n \"passphrase\": \"\",\n \"publicKey\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"publicKey\": \"\",\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93927eb6-a6a5-49f4-bacd-c7f0d4077e02", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"pgpKey\": {\n \"privateKey\": \"\",\n \"passphrase\": \"\",\n \"publicKey\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac17c3ba-34ee-426a-83f1-9edc179a62d0", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "accounts", ":accountID", "pipelines", "encryptionKeys", ":ID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "type": "any", "value": "", "key": "accountID" }, { "disabled": false, "description": { "content": "(Required) ID of the key.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"encryptionProtocol\": \"NONE_PROTOCOL\",\n \"pgpKey\": {\n \"privateKey\": \"\",\n \"passphrase\": \"\",\n \"publicKey\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97b11d11-7d0a-435b-b3b6-c3682342e14c", "name": "List Pipelines", "request": { "name": "List Pipelines", "description": { "content": "Lists the pipelines you can access.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Name of the pipeline.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipelines.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of pipelines to retrieve. Maximum 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b3c4fd51-5d7a-45cf-b1e7-7217d044a1b8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Name of the pipeline.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipelines.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of pipelines to retrieve. Maximum 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"pipelines\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"source\": {\n \"dataFormat\": \"JSON\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"SSH_RSA\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"PSV\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"NOT_EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"NOT_EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"status\": \"CREATED\",\n \"action\": \"DEIDENTIFY\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"source\": {\n \"dataFormat\": \"PARQUET\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TSV\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"status\": \"CREATED\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5e402c-5d23-40f9-9436-2c670520a472", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Name of the pipeline.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipelines.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of pipelines to retrieve. Maximum 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d26b5f9-4551-428b-8d07-adfa86ab9a44", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Name of the pipeline.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipelines.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of pipelines to retrieve. Maximum 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d00aedd-15c1-47e5-a2fa-779fa5456de0", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Name of the pipeline.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipelines.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of pipelines to retrieve. Maximum 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67fa17b1-217b-41a6-97a5-2991f8e738e3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Name of the pipeline.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipelines.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of pipelines to retrieve. Maximum 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7c92471-da13-4aa4-b545-ba86685d5afb", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Name of the pipeline.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipelines.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of pipelines to retrieve. Maximum 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ea4df60-041f-4434-993b-e73a24734e01", "name": "Create Pipeline", "request": { "name": "Create Pipeline", "description": { "content": "Creates a pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"vaultID\": \"\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"dataFormat\": \"AUDIO\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TEXT\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "a93ba8bf-0ca3-435f-b5ba-1d9bdfe6d28d", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"vaultID\": \"\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"dataFormat\": \"AUDIO\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TEXT\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "777e7c20-f76a-42b9-a8c5-e9a994783caf", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"vaultID\": \"\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"dataFormat\": \"AUDIO\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TEXT\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b838c768-eeac-4658-bdc7-2351ae69d108", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"vaultID\": \"\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"dataFormat\": \"AUDIO\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TEXT\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "220f7f50-bb8d-47b2-992e-996c0d873443", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"vaultID\": \"\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"dataFormat\": \"AUDIO\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TEXT\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "167745d2-d9e5-4edf-b758-6bb69dd1e9e5", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"vaultID\": \"\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"dataFormat\": \"AUDIO\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TEXT\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06a34189-1c8f-4442-89bb-85b15b33c180", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"vaultID\": \"\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"dataFormat\": \"AUDIO\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TEXT\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"plainText\": {\n \"hostname\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n },\n \"encrypted\": {\n \"encryptedCredentials\": \"\"\n },\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"EQUALS\"\n }\n ]\n }\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f185921d-c654-44d3-b440-0646306acedc", "name": "Delete Pipeline", "request": { "name": "Delete Pipeline", "description": { "content": "Deletes the specified pipeline and the entities it contains.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "57c33b9a-bd51-41fc-a749-c81132c10552", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd7137f7-0e8a-42c0-94be-76727577b79a", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d84d494-da03-461c-be02-866e1a011a74", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "102748a7-dcf9-48a8-b5fb-6f830be7a4a2", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4207ae0-7e3d-47c4-9ebb-7baa5b5fb396", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15582218-9d93-485b-975f-b4da42c8041e", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b143fa13-6b84-46e3-92e3-5a3508cbbbde", "name": "Get Pipeline", "request": { "name": "Get Pipeline", "description": { "content": "Returns the specified pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b966044e-f712-4978-bcb0-3c3ed648e3a0", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"pipeline\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"source\": {\n \"dataFormat\": \"CSV\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"fixedWidthFormat\": {\n \"linesPerRecord\": \"\"\n },\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"excludeFiles\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"destination\": {\n \"dataFormat\": \"TSV\",\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"encryptionProtocol\": \"PGP\",\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"transferProtocol\": \"SFTP\",\n \"skyflowHosted\": \"\"\n },\n \"s3Bucket\": {\n \"name\": \"\",\n \"region\": \"\",\n \"assumedRoleARN\": \"\"\n }\n },\n \"dataMappings\": [\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"NOT_EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"NOT_EQUALS\"\n }\n ]\n },\n {\n \"tableName\": \"\",\n \"fieldMapping\": [\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n },\n {\n \"sourceField\": {\n \"columnName\": \"\",\n \"jsonFieldName\": \"\",\n \"fieldName\": \"\",\n \"tokenColumnName\": \"\",\n \"fixedWidthField\": {\n \"value\": {\n \"positionFirst\": \"\",\n \"positionLast\": \"\",\n \"trimWhitespace\": \"\"\n },\n \"matchLines\": {\n \"regex\": \"\",\n \"positionFirst\": \"\",\n \"positionLast\": \"\"\n }\n }\n },\n \"columnName\": \"\"\n }\n ],\n \"primaryKey\": \"\",\n \"conditions\": [\n {\n \"value\": \"\",\n \"comparator\": \"NOT_EQUALS\"\n },\n {\n \"value\": \"\",\n \"comparator\": \"NOT_EQUALS\"\n }\n ]\n }\n ],\n \"status\": \"CREATED\",\n \"action\": \"IMPORT\",\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd991a2e-76ca-4d57-a7e2-c4e862e351a4", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c49ebce5-5a74-43e6-a98e-6a0db4a18764", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "890fb651-8561-4acf-8d7c-a579e2c63ac1", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d85ebed-1230-4649-a85e-3d6674f668f0", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc9167ac-b8da-4a59-ba95-f244861713b9", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "696ce93c-bc26-406a-a550-3bd781d38976", "name": "Update Pipeline", "request": { "name": "Update Pipeline", "description": { "content": "Updates the specified pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"destination\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "8b351a49-cc5d-446e-ae2a-6620a37ef258", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"destination\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b933a53b-0b7d-4bfa-9f19-2bab3ebccb89", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"destination\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a01f3be-b87f-43f8-8ebc-3096f4e60856", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"destination\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68c2f745-d427-4f5d-ba28-6eaa18f17295", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"source\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"destination\": {\n \"encryptionKeyID\": \"\",\n \"ftpServer\": {\n \"plainText\": {\n \"username\": \"\",\n \"password\": \"\",\n \"sshKeyID\": \"\"\n }\n }\n },\n \"runTriggers\": [\n \"ON_DEMAND\",\n \"ON_DEMAND\"\n ],\n \"reportOptions\": {\n \"recordIdentifiers\": [\n \"\",\n \"\"\n ],\n \"recordsPerFile\": \"\",\n \"exportDirectoryTrim\": {\n \"trimUntilDepth\": \"\",\n \"trimUntilDirectory\": \"\",\n \"trimPrefix\": \"\"\n },\n \"eventTypesToEmit\": [\n \"pipelineRun.fileCompleted\",\n \"pipelineRun.fileCompleted\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "474d7959-67f6-41cf-a51e-586329863d99", "name": "Run Pipeline", "request": { "name": "Run Pipeline", "description": { "content": "Runs the specified pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines", ":ID", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"exportDirectory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "844e10de-be56-4d4e-8e7a-66202929493c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"exportDirectory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"runID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31a36137-a82d-4f26-acc5-4313977436ea", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"exportDirectory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57f18787-b246-4c03-b8fb-4a9a5ba4c28c", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"exportDirectory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13b7a807-f8ab-41f4-9f10-5a6e130ba4b3", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"exportDirectory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f76939e5-8fdc-4814-8430-a81c0d018cd6", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"exportDirectory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05263fd2-f703-46af-bcc6-d184e68f8f61", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "run" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileNameRegexes\": [\n \"\",\n \"\"\n ],\n \"exportDirectory\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba8c0803-ebb3-4400-bd67-00dc68fd0ca8", "name": "Stop Pipeline Run", "request": { "name": "Stop Pipeline Run", "description": { "content": "Stops the specified pipeline run.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines", ":ID", "runs", ":runID", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "runID", "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bc2947a2-22b2-476d-a6ed-ac94e90df5c5", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "runs", ":runID", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "runID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"runID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72e6516c-2ce7-4f87-a418-5797d4115062", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "runs", ":runID", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "runID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91bf63bf-68ac-414b-b5d6-e89494727900", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "runs", ":runID", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "runID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6676a2f6-7a3a-4627-8d28-3020c2e2d0eb", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "runs", ":runID", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "runID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "604acf5e-7001-4e19-8a0d-2aa360da3e68", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "runs", ":runID", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "runID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80a3f275-e7d3-4a02-ac58-d857d5491bf8", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":ID", "runs", ":runID", "stop" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "runID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b2f2eed-361e-4d98-897d-5c2bfa7fe729", "name": "List Pipeline Runs", "request": { "name": "List Pipeline Runs", "description": { "content": "Lists runs of the specified pipeline.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of the pipeline run. (This can only be one of SUCCEEDED,FAILED)", "type": "text/plain" }, "key": "filterOps.state", "value": "SUCCEEDED" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipeline runs.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of pipeline runs to retrieve.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "pipelineID", "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f423ccb0-1174-4799-bbb9-8d40994b24f6", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of the pipeline run. (This can only be one of SUCCEEDED,FAILED)", "type": "text/plain" }, "key": "filterOps.state", "value": "SUCCEEDED" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipeline runs.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of pipeline runs to retrieve.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"pipelineRuns\": [\n {\n \"ID\": \"\",\n \"pipelineID\": \"\",\n \"state\": \"SUCCEEDED\",\n \"error\": \"\",\n \"parserErrorFileURL\": \"\",\n \"vaultErrorFileURL\": \"\",\n \"tokenFileURL\": \"\",\n \"deidentifyReportFileURL\": \"\"\n },\n {\n \"ID\": \"\",\n \"pipelineID\": \"\",\n \"state\": \"FAILED\",\n \"error\": \"\",\n \"parserErrorFileURL\": \"\",\n \"vaultErrorFileURL\": \"\",\n \"tokenFileURL\": \"\",\n \"deidentifyReportFileURL\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c98b68f3-4d86-4d6b-94e7-3bb9366bbec5", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of the pipeline run. (This can only be one of SUCCEEDED,FAILED)", "type": "text/plain" }, "key": "filterOps.state", "value": "SUCCEEDED" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipeline runs.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of pipeline runs to retrieve.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb82b216-32b9-4434-b165-62026e590107", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of the pipeline run. (This can only be one of SUCCEEDED,FAILED)", "type": "text/plain" }, "key": "filterOps.state", "value": "SUCCEEDED" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipeline runs.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of pipeline runs to retrieve.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5947803-4356-4b5f-9fb3-2d0e4674098f", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of the pipeline run. (This can only be one of SUCCEEDED,FAILED)", "type": "text/plain" }, "key": "filterOps.state", "value": "SUCCEEDED" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipeline runs.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of pipeline runs to retrieve.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf6aafab-b27c-4a07-81f8-950c3c58851a", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of the pipeline run. (This can only be one of SUCCEEDED,FAILED)", "type": "text/plain" }, "key": "filterOps.state", "value": "SUCCEEDED" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipeline runs.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of pipeline runs to retrieve.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fea3d46-f677-4526-a9ed-0a3d16cb03ba", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "State of the pipeline run. (This can only be one of SUCCEEDED,FAILED)", "type": "text/plain" }, "key": "filterOps.state", "value": "SUCCEEDED" }, { "disabled": true, "description": { "content": "Record position at which to start retrieving pipeline runs.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of pipeline runs to retrieve.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "522e08c0-69db-4d50-91f7-cf72bb50c3d9", "name": "Get Pipeline Run", "request": { "name": "Get Pipeline Run", "description": { "content": "Returns the specified pipeline run.", "type": "text/plain" }, "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "pipelineID", "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "35b77ec3-3ff4-437b-942d-726f9e5d57dd", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"pipelineRun\": {\n \"ID\": \"\",\n \"pipelineID\": \"\",\n \"state\": \"RUNNING\",\n \"error\": \"\",\n \"parserErrorFileURL\": \"\",\n \"vaultErrorFileURL\": \"\",\n \"tokenFileURL\": \"\",\n \"deidentifyReportFileURL\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7973589f-9da9-4635-bc22-a6d45e61896e", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d876f86-99db-457e-a63d-87f06659be9f", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39628d54-9a90-4141-a4cf-231fb67d0329", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae40eed7-d0a2-4d8a-83ce-3cd277525fcb", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cfc7b2c-2dde-48cd-9832-25f165b8cbb0", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "pipelines", ":pipelineID", "runs", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the pipeline.", "type": "text/plain" }, "type": "any", "value": "", "key": "pipelineID" }, { "disabled": false, "description": { "content": "(Required) ID of the pipeline run.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Policies", "description": "", "item": [ { "id": "fb0c80ce-398e-43d6-aa42-d37c4c3fa605", "name": "List Policies", "request": { "name": "List Policies", "description": { "content": "Lists policies associated with a resource.", "type": "text/plain" }, "url": { "path": [ "v1", "policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "filter that limits results to those that match the specified name.\n\nstring ruleName = 2;\n Action action = 3;\n Effect effect = 4;", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bd755bac-b951-42f5-bf6d-ff8436ccc0c7", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "filter that limits results to those that match the specified name.\n\nstring ruleName = 2;\n Action action = 3;\n Effect effect = 4;", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policies\": [\n {\n \"name\": \"kds\",\n \"ID\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"l2RdVfxq\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"GqDIicgMQ\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n },\n {\n \"name\": \"Vp1ZZL7nns\",\n \"ID\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"YaBJZ\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"U0udL71\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d84248e2-9675-4d1d-a08c-8f2062dff31a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "filter that limits results to those that match the specified name.\n\nstring ruleName = 2;\n Action action = 3;\n Effect effect = 4;", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "659c11ba-a29f-4c7f-813c-209ba3ac6b1b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "filter that limits results to those that match the specified name.\n\nstring ruleName = 2;\n Action action = 3;\n Effect effect = 4;", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9d40e269-c58e-4cb2-a4a4-e48cb69751b5", "name": "Create Policy", "request": { "name": "Create Policy", "description": { "content": "Creates a policy for the specified resource.", "type": "text/plain" }, "url": { "path": [ "v1", "policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"ruleParams\": [\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n ],\n \"activated\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "83288106-9adc-4f93-9ada-318ee38449d2", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"ruleParams\": [\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n ],\n \"activated\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7abad6a-87cc-466e-97f6-12c67547d890", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"ruleParams\": [\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n ],\n \"activated\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cb024be-bb7d-455e-b66d-25163be15152", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"ruleParams\": [\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n ],\n \"activated\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e982e81-baf4-4c32-bc0b-9f1ceb7361e3", "name": "Assign Policy", "request": { "name": "Assign Policy", "description": { "content": "Assigns a policy to one or more roles.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"roleIDs\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ],\n \"exceptions\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5f6efdd2-982f-49e4-8c52-6983d8c72d40", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"roleIDs\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ],\n \"exceptions\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68130ac4-db69-47d3-9390-88e748d77ad4", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"roleIDs\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ],\n \"exceptions\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fee1dbad-b69a-4a80-8171-748a644059bd", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", "assign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"roleIDs\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ],\n \"exceptions\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00b0bfd6-4204-4fc1-ad20-3b35da1c0aa4", "name": "Create Rule", "request": { "name": "Create Rule", "description": { "content": "Creates a rule in a policy.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"policyID\": \"\",\n \"ruleParams\": {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "5c22f9cc-3c8d-41f3-9f7e-4d62c4d46098", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"policyID\": \"\",\n \"ruleParams\": {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22d86378-3355-4fcd-82f2-b0ea1044000a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"policyID\": \"\",\n \"ruleParams\": {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68a1704a-083f-45e5-9dd3-27aeca869f1f", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"policyID\": \"\",\n \"ruleParams\": {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6178940-c800-4929-acd6-6d0d9f2062cb", "name": "Delete Rule", "request": { "name": "Delete Rule", "description": { "content": "Deletes a rule from a policy.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the policy that contains the rule.", "type": "text/plain" }, "key": "policyID", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "ae2fdba9-370e-4bf6-bbea-a9d40042684e", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the policy that contains the rule.", "type": "text/plain" }, "key": "policyID", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0884e803-7798-4b49-aa25-b4403a33dc54", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the policy that contains the rule.", "type": "text/plain" }, "key": "policyID", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d64c0cb3-e74f-4fe4-b6e1-c9f0bb0c1d3a", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the policy that contains the rule.", "type": "text/plain" }, "key": "policyID", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c87b679-e5d8-4323-ac45-fc5c92438827", "name": "Get Rule", "request": { "name": "Get Rule", "description": { "content": "Returns the specified rule.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the policy that contains the rule.", "type": "text/plain" }, "key": "policyID", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b5f9fe3d-da59-4b3d-878b-ba9b23d15eb3", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the policy that contains the rule.", "type": "text/plain" }, "key": "policyID", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"rule\": {\n \"name\": \"GC\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7330cd54-a358-4b65-9686-d1ed68119309", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the policy that contains the rule.", "type": "text/plain" }, "key": "policyID", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d4a4290-ee85-477a-91e3-faa5840a12fe", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the policy that contains the rule.", "type": "text/plain" }, "key": "policyID", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a4c37d6-7219-41f6-9d9d-b87fecfd24ce", "name": "Update Rule", "request": { "name": "Update Rule", "description": { "content": "Update a rule.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"policyID\": \"\",\n \"ruleParams\": {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e6b368cc-0d24-4801-a48c-f7f0ddbb0ff5", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"policyID\": \"\",\n \"ruleParams\": {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d12c6348-655d-4c1d-9874-5bc180aeb4ff", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"policyID\": \"\",\n \"ruleParams\": {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4abc592-792d-4b0b-8dfe-cfc935dbeb1e", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", "rules", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the rule.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"policyID\": \"\",\n \"ruleParams\": {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0be631b-5f1a-4def-88f3-b98f0bd7939a", "name": "Unassign Policy", "request": { "name": "Unassign Policy", "description": { "content": "Unassigns a policy from one or more roles.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", "unassign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"roleIDs\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4fb4ecde-525a-42a0-9b51-3c6ec16c6e96", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", "unassign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"roleIDs\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64137bfb-1982-4514-a06b-b223cfe7776f", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", "unassign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"roleIDs\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77921864-6cba-4270-8b11-282566903225", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", "unassign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"roleIDs\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dab78935-72b4-418a-b8ce-d70c7595eee6", "name": "Delete Policy", "request": { "name": "Delete Policy", "description": { "content": "Deletes the specified policy.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "1c8ee97b-c031-43d1-9f91-3767b61b8a99", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbfd9895-b777-48d7-8d1f-5c0c11d3cb8a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea91268-4f66-4c25-a5a4-481543dc9bce", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d822130-f4bf-4c54-9684-235048442fa4", "name": "Get Policy", "request": { "name": "Get Policy", "description": { "content": "Returns the specified policy.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a8a3bc79-6923-460e-9730-b4ac2d7d78bd", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policy\": {\n \"name\": \"uk67IuDV\",\n \"ID\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"Ocu7\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"mSQ0tpvsu\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "641cdbfc-a37c-432c-89b4-ddefd1a5b0e1", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c13fb7f-2e00-4338-955d-69530cb04928", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fdfec84-3e75-41ce-90bf-6c110d742b42", "name": "Update Policy", "request": { "name": "Update Policy", "description": { "content": "Updates the specified policy.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"policy\": {\n \"name\": \"Z7KC\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"pgXk\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"2l3vkr\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n },\n \"ruleParams\": [\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f976091b-b837-4e0b-ac7e-2fdc66a592d1", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"policy\": {\n \"name\": \"Z7KC\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"pgXk\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"2l3vkr\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n },\n \"ruleParams\": [\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdcaeccb-e967-4a04-8627-732e566be782", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"policy\": {\n \"name\": \"Z7KC\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"pgXk\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"2l3vkr\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n },\n \"ruleParams\": [\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b917f99d-5275-41ae-b437-1bdd6853654c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the policy.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"policy\": {\n \"name\": \"Z7KC\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"pgXk\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"2l3vkr\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n },\n \"ruleParams\": [\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n },\n {\n \"name\": \"\",\n \"ID\": \"\",\n \"ruleExpression\": \"\",\n \"columnRuleParams\": {\n \"vaultID\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"tableRuleParams\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n },\n \"columnGroupRuleParams\": {\n \"vaultID\": \"\",\n \"columnGroups\": [\n \"\",\n \"\"\n ],\n \"action\": \"NONE_ACTION\",\n \"effect\": \"NONE_EFFECT\",\n \"rowFilter\": \"\",\n \"redaction\": \"\",\n \"actions\": [\n \"NONE_ACTION\",\n \"NONE_ACTION\"\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3f764b1-2e26-4e5b-9a94-79c2aeb1d3f1", "name": "Update Policy Status", "request": { "name": "Update Policy Status", "description": { "content": "Updates a policy's status.", "type": "text/plain" }, "url": { "path": [ "v1", "policies", ":ID", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the entity to update.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"NONE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ef895411-9a44-4ca9-87bd-b183db7b0173", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the entity to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"NONE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "047f10d1-8eff-4752-ad23-e1b06ac8118c", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the entity to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"NONE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "087dfe5e-52f1-46bf-8a74-2a873351dadd", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "policies", ":ID", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the entity to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"NONE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee442028-62ef-4039-90b3-5b1911908a79", "name": "List Policies By Role", "request": { "name": "List Policies By Role", "description": { "content": "Lists policies assigned to a role.", "type": "text/plain" }, "url": { "path": [ "v1", "roles", ":roleID", "policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified policy name.\n\nAction action = 2;\n Effect effect = 3;", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to receive.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "type": "any", "value": "", "key": "roleID", "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "249b681c-0836-43a4-a2a5-8ddf033f7bea", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":roleID", "policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified policy name.\n\nAction action = 2;\n Effect effect = 3;", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to receive.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "roleID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"policies\": [\n {\n \"name\": \"VpI\",\n \"ID\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"umyjTMdCv\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"LJVAxE\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n },\n {\n \"name\": \"g\",\n \"ID\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n \"members\": [\n \"\",\n \"\"\n ],\n \"rules\": [\n {\n \"name\": \"Bgvl14\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n },\n {\n \"name\": \"9pUZ\",\n \"ID\": \"\",\n \"effect\": \"NONE_EFFECT\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"resources\": [\n \"\",\n \"\"\n ],\n \"resourceType\": \"ACCOUNT\",\n \"dlpFormat\": \"NONE_FORMAT\",\n \"condition\": \"\",\n \"rowFilter\": \"\",\n \"ruleExpression\": \"\",\n \"redaction\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbef32e5-1a64-4048-81d1-d059bb6829a6", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "roles", ":roleID", "policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified policy name.\n\nAction action = 2;\n Effect effect = 3;", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to receive.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "roleID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98ef3910-1095-4b30-9080-8b21cfef3407", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "roles", ":roleID", "policies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified policy name.\n\nAction action = 2;\n Effect effect = 3;", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to receive.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the role.", "type": "text/plain" }, "type": "any", "value": "", "key": "roleID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Service Accounts", "description": "", "item": [ { "id": "1d26ec9a-17fd-4514-a6e3-aaee100971e4", "name": "List Service Accounts", "request": { "name": "List Service Accounts", "description": { "content": "Lists service accounts.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at with to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": false, "description": { "content": "(Required) Deprecated. ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Deprecated. Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Deprecated. Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Deprecated. Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Number of levels of contained resources for which to return associated service accounts, starting at the specified resource.", "type": "text/plain" }, "key": "depth", "value": "5" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "872dbf58-8201-44d4-8a8d-00f226f56e7a", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at with to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": false, "description": { "content": "(Required) Deprecated. ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Deprecated. Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Deprecated. Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Deprecated. Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Number of levels of contained resources for which to return associated service accounts, starting at the specified resource.", "type": "text/plain" }, "key": "depth", "value": "5" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serviceAccounts\": [\n {\n \"serviceAccount\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n },\n \"ID\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n },\n {\n \"serviceAccount\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n },\n \"ID\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88a8a3d1-b3dd-4f5b-9873-70a15ded35a9", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at with to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": false, "description": { "content": "(Required) Deprecated. ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Deprecated. Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Deprecated. Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Deprecated. Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Number of levels of contained resources for which to return associated service accounts, starting at the specified resource.", "type": "text/plain" }, "key": "depth", "value": "5" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd50137b-392e-481d-99a7-04bdb82aa7f2", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at with to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": " (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": false, "description": { "content": "(Required) Deprecated. ID of the resource. For example, if `resource.type` is `VAULT`, this field is the vault ID. If `resource.type` is `WORKSPACE`, this field is the workspace ID.", "type": "text/plain" }, "key": "resource.ID", "value": "" }, { "disabled": false, "description": { "content": "(Required) Deprecated. Type of the resource. (This can only be one of NONE,ORGANIZATION,VAULT,ACCOUNT,SERVICE_ACCOUNT,VAULT_TEMPLATE,WORKSPACE,FIELD_TEMPLATE,RECORD,TOKEN,CONNECTION,ENCRYPTION_KEY,NETWORK_TOKEN,SUBSCRIPTION,PAYMENT_CONFIG)", "type": "text/plain" }, "key": "resource.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Deprecated. Name of the resource.", "type": "text/plain" }, "key": "resource.name", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Unique namespace for the resource. Generated by Skyflow.", "type": "text/plain" }, "key": "resource.namespace", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Description of the resource.", "type": "text/plain" }, "key": "resource.description", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Status of the resource. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "resource.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Deprecated. Display name of the resource that appears in user interfaces.", "type": "text/plain" }, "key": "resource.displayName", "value": "" }, { "disabled": true, "description": { "content": "Deprecated. Number of levels of contained resources for which to return associated service accounts, starting at the specified resource.", "type": "text/plain" }, "key": "depth", "value": "5" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6faed98a-79f4-4e44-8158-06be2a8cc5b3", "name": "Create Service Account", "request": { "name": "Create Service Account", "description": { "content": "Creates a service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"ACCOUNT\",\n \"name\": \"\",\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"accountID\": \"\",\n \"serviceAccount\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "4bfd3f48-c1b2-461b-bff1-1973d5651610", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"ACCOUNT\",\n \"name\": \"\",\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"accountID\": \"\",\n \"serviceAccount\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientID\": \"\",\n \"clientName\": \"\",\n \"tokenURI\": \"\",\n \"keyID\": \"\",\n \"privateKey\": \"\",\n \"keyValidAfterTime\": \"\",\n \"keyValidBeforeTime\": \"\",\n \"apiKeyID\": \"\",\n \"apiKey\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc60ea16-84a1-4a88-9f57-31633119ac94", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"ACCOUNT\",\n \"name\": \"\",\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"accountID\": \"\",\n \"serviceAccount\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b8b5303-f19a-4a4d-beed-7c7cde4c0e17", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": {\n \"ID\": \"\",\n \"type\": \"ACCOUNT\",\n \"name\": \"\",\n \"description\": \"\",\n \"displayName\": \"\"\n },\n \"accountID\": \"\",\n \"serviceAccount\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2c53648e-afa1-438b-a45e-5f092a9df245", "name": "Delete Service Account", "request": { "name": "Delete Service Account", "description": { "content": "Deletes the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "21e13e8f-869e-47f8-ab15-5c2146f1ce2a", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24344907-b0f3-4533-9321-95697d8de933", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2f75e89-0c9a-4695-a0a8-efe38212db34", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06751531-24f2-438c-8d80-1078393ed33c", "name": "Get Service Account", "request": { "name": "Get Service Account", "description": { "content": "Returns the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "098d0d31-f0c0-4ae3-87ab-e802665e8c84", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"serviceAccount\": {\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n },\n \"ID\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88dac78e-b2f6-4b71-bcce-e946c1113972", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9a3103d-9f61-418d-a749-1036862c7ab3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1d911f3c-b461-4937-87d5-8f6175b9de39", "name": "Update Service Account", "request": { "name": "Update Service Account", "description": { "content": "Updates the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"serviceAccount\": {\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ceefc1a9-e3e7-43fb-bede-faeb097c9d8f", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"serviceAccount\": {\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ID\": \"\",\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c46bd182-7788-43e9-abfc-f35332ee6ae4", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"serviceAccount\": {\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ca3b600-1db6-448b-b805-04ecbcbc9cf6", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"serviceAccount\": {\n \"displayName\": \"\",\n \"description\": \"\",\n \"ipAllowlist\": {\n \"status\": \"INACTIVE\",\n \"cidrBlocks\": [\n \"\",\n \"\"\n ]\n }\n },\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9d86f5f-c15a-41bc-8c2f-63f888f7c58f", "name": "List API Keys", "request": { "name": "List API Keys", "description": { "content": "Lists API keys for the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e14ad4bc-7dd5-4223-b133-17f5afb87f09", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"apiKeys\": [\n {\n \"keyID\": \"\",\n \"identifier\": \"\",\n \"status\": \"\",\n \"keyValidAfterTime\": \"\"\n },\n {\n \"keyID\": \"\",\n \"identifier\": \"\",\n \"status\": \"\",\n \"keyValidAfterTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6f630a3-1a43-425d-9fcd-fbeafe8a8b59", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88289d87-1a40-4d14-8b13-e75d9b93cce6", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "16d2f652-688d-46e7-8c3b-3ff1bdccb216", "name": "Create API Key", "request": { "name": "Create API Key", "description": { "content": "Creates an API key for the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "81744c6a-33bd-4895-8ba4-944f68bbdc17", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientID\": \"\",\n \"clientName\": \"\",\n \"tokenURI\": \"\",\n \"keyID\": \"\",\n \"privateKey\": \"\",\n \"keyValidAfterTime\": \"\",\n \"keyValidBeforeTime\": \"\",\n \"apiKeyID\": \"\",\n \"apiKey\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80fc75f3-97a9-4d07-bd24-8b2911a645de", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aabcfec8-28e6-4796-92a5-f85b49dddbb8", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "014176b4-b8cf-46c7-8890-d63c9e3e1979", "name": "Delete API Key", "request": { "name": "Delete API Key", "description": { "content": "Deletes the specified API key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "keyID", "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d4818dba-fcff-412a-8594-dcc858ca0b59", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"keyID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dd01aec-f5b8-424d-b062-ee184b9973b3", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03b60f72-4cdf-4dbc-b7f9-a5450674daae", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df7e5654-020d-4e16-aa4c-275cee69b874", "name": "Get API Key", "request": { "name": "Get API Key", "description": { "content": "Returns the specified API key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "keyID", "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fa8151b6-9d60-4b18-b045-7fe0d70a1c87", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keyID\": \"\",\n \"identifier\": \"\",\n \"status\": \"\",\n \"keyValidAfterTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6edd0dc1-d34e-4d86-b5bf-04d9a14b4f29", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bef5ae2d-9f4e-46f5-8b51-b37e74e12299", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d328a329-1348-4b41-a371-84632cc46acb", "name": "Rotate API Key", "request": { "name": "Rotate API Key", "description": { "content": "Rotates the specified API key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "keyID", "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": null }, "response": [ { "id": "6c7ce120-a677-4e5b-8582-7dee64189386", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientID\": \"\",\n \"clientName\": \"\",\n \"tokenURI\": \"\",\n \"keyID\": \"\",\n \"privateKey\": \"\",\n \"keyValidAfterTime\": \"\",\n \"keyValidBeforeTime\": \"\",\n \"apiKeyID\": \"\",\n \"apiKey\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83843684-71fa-4ee4-b704-ee4b53e5d0d0", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a2eeede-337a-4a93-bdd6-9a2db91c9cb3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "apikey", ":keyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the API key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31801761-b144-4321-ab06-472da9f24680", "name": "List Keys", "request": { "name": "List Keys", "description": { "content": "Lists keys for the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filters that limits results to those that match the specified key type.\n\n - USER_MANAGED: Keys managed and rotated by the users.\n - SYSTEM_MANAGED: Keys managed and rotated by Skyflow.", "type": "text/plain" }, "key": "keyTypes", "value": "SYSTEM_MANAGED" }, { "disabled": true, "description": { "content": "Filters that limits results to those that match the specified key type.\n\n - USER_MANAGED: Keys managed and rotated by the users.\n - SYSTEM_MANAGED: Keys managed and rotated by Skyflow.", "type": "text/plain" }, "key": "keyTypes", "value": "USER_MANAGED" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "530b3d6f-bb82-4cb4-ad55-926175138330", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filters that limits results to those that match the specified key type.\n\n - USER_MANAGED: Keys managed and rotated by the users.\n - SYSTEM_MANAGED: Keys managed and rotated by Skyflow.", "type": "text/plain" }, "key": "keyTypes", "value": "USER_MANAGED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keys\": [\n {\n \"keyID\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\",\n \"privateKeyData\": \"B+c9sNG9\",\n \"publicKeyData\": \"QohsmSswJ7nMKf0j0voW7ghtoCqESYUxsWy9+u0z\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\"\n },\n {\n \"keyID\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\",\n \"privateKeyData\": \"S7lzcRIKzkgszvA6rHhOfhQG\",\n \"publicKeyData\": \"JJfm\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04106ba0-aeed-44b1-b2a0-d4c35eab1fbc", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filters that limits results to those that match the specified key type.\n\n - USER_MANAGED: Keys managed and rotated by the users.\n - SYSTEM_MANAGED: Keys managed and rotated by Skyflow.", "type": "text/plain" }, "key": "keyTypes", "value": "USER_MANAGED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0849024-1962-45d5-928c-48cff521ee80", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filters that limits results to those that match the specified key type.\n\n - USER_MANAGED: Keys managed and rotated by the users.\n - SYSTEM_MANAGED: Keys managed and rotated by Skyflow.", "type": "text/plain" }, "key": "keyTypes", "value": "USER_MANAGED" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b227a53f-dcd6-4568-bbde-20ffba491c8c", "name": "Create Key", "request": { "name": "Create Key", "description": { "content": "Creates a key for the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "cc63d05c-f089-4703-b2a9-5ccf0d61dae2", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientID\": \"\",\n \"clientName\": \"\",\n \"tokenURI\": \"\",\n \"keyID\": \"\",\n \"privateKey\": \"\",\n \"keyValidAfterTime\": \"\",\n \"keyValidBeforeTime\": \"\",\n \"apiKeyID\": \"\",\n \"apiKey\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8af5a377-0522-45f8-b63a-ae1f7343ff60", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cdd7ba4-47f8-4401-a419-34b8604f306b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "625194da-00a0-48d1-bfd0-e2c070059db9", "name": "Rotate Key", "request": { "name": "Rotate Key", "description": { "content": "Rotates the specified key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":KeyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "KeyID", "disabled": false, "description": { "content": "(Required) ID of the key linked with the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": null }, "response": [ { "id": "4e98b870-cad0-4b7e-a415-225010dbfd4a", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":KeyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the key linked with the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "KeyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientID\": \"\",\n \"clientName\": \"\",\n \"tokenURI\": \"\",\n \"keyID\": \"\",\n \"privateKey\": \"\",\n \"keyValidAfterTime\": \"\",\n \"keyValidBeforeTime\": \"\",\n \"apiKeyID\": \"\",\n \"apiKey\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7568e64f-ce3e-4dc7-b8cf-edaf7cb77ba7", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":KeyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the key linked with the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "KeyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d4df47b-8af3-4edf-a0db-e33943c2525b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":KeyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the key linked with the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "KeyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b3246d2-f726-4aa6-baca-c37ccc33f14e", "name": "Delete Key", "request": { "name": "Delete Key", "description": { "content": "Deletes the specified key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "keyID", "disabled": false, "description": { "content": "(Required) ID of the service account key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "de54ee1e-144a-4e20-b3df-d593e3febc4a", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the service account key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"keyID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37a35ef0-7d32-4ee9-a361-efb57522695c", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the service account key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0fec579-6697-42b4-9990-52ec5bb3930a", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the service account key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "69fb3ba3-5626-40c0-9682-aa4683b97fc1", "name": "Get Key", "request": { "name": "Get Key", "description": { "content": "Returns the specified key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Output format of the public key. (This can only be one of TYPE_NONE,TYPE_X509_PEM_FILE,TYPE_RAW_PUBLIC_KEY)", "type": "text/plain" }, "key": "publicKeyType", "value": "TYPE_NONE" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "keyID", "disabled": false, "description": { "content": "(Required) ID of the service account key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cfd5afc8-c570-4748-b00f-a4dc711ef3c8", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Output format of the public key. (This can only be one of TYPE_NONE,TYPE_X509_PEM_FILE,TYPE_RAW_PUBLIC_KEY)", "type": "text/plain" }, "key": "publicKeyType", "value": "TYPE_NONE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the service account key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keyID\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\",\n \"privateKeyData\": \"LrPG9ZftsbR=\",\n \"publicKeyData\": \"\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4aa15a6-806c-466e-9007-627c7f42717a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Output format of the public key. (This can only be one of TYPE_NONE,TYPE_X509_PEM_FILE,TYPE_RAW_PUBLIC_KEY)", "type": "text/plain" }, "key": "publicKeyType", "value": "TYPE_NONE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the service account key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98ffc6e0-93d4-4875-b823-b2e766f8b15c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "keys", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Output format of the public key. (This can only be one of TYPE_NONE,TYPE_X509_PEM_FILE,TYPE_RAW_PUBLIC_KEY)", "type": "text/plain" }, "key": "publicKeyType", "value": "TYPE_NONE" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the service account key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa1e3109-2a03-4622-8450-ef35f36790c1", "name": "List Signed Token Keys", "request": { "name": "List Signed Token Keys", "description": { "content": "Returns signed token keys for the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cd7a9ceb-83d9-4e7b-a307-32fa6c4de9fe", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keys\": [\n {\n \"keyID\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\",\n \"privateKeyData\": \"JoWp\",\n \"publicKeyData\": \"MZOl\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\"\n },\n {\n \"keyID\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\",\n \"privateKeyData\": \"ceec+VrruBVx1qEklanvTjJavrf=\",\n \"publicKeyData\": \"U6ebBV0IyMNkl5hIbrsjBq==\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c5c6ef5-e586-431f-a17d-b4f8ff1af4ba", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dad0dd05-9b9c-4abf-a24c-8d948837a33c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3c55c3e-bb35-43d9-9c0c-932fc6bc6a0d", "name": "Create Signed Token Key", "request": { "name": "Create Signed Token Key", "description": { "content": "Creates a signed token key for the specified service account.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "7aa291c7-4f68-4271-925c-c71b7f084a65", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientID\": \"\",\n \"clientName\": \"\",\n \"tokenURI\": \"\",\n \"keyID\": \"\",\n \"privateKey\": \"\",\n \"keyValidAfterTime\": \"\",\n \"keyValidBeforeTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3abbf2-9392-43fd-a8b3-257f4a1353c2", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5aeefb59-beba-4a76-8c3c-96ce4ab4c709", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "362c3aa9-8bb5-4d45-a6fc-d094d271a9aa", "name": "Rotate Signed Token Key", "request": { "name": "Rotate Signed Token Key", "description": { "content": "Rotates the specified signed token key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":KeyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "KeyID", "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": null }, "response": [ { "id": "c807b6a1-7203-4bb6-8f60-e8477f23dfd5", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":KeyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "KeyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"clientID\": \"\",\n \"clientName\": \"\",\n \"tokenURI\": \"\",\n \"keyID\": \"\",\n \"privateKey\": \"\",\n \"keyValidAfterTime\": \"\",\n \"keyValidBeforeTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59224798-a0b4-456b-a3bd-d3f0a5bfe3b1", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":KeyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "KeyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3ad6f04-75dc-4610-a107-9c23c7006769", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":KeyID", "rotate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "KeyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b853dcb-d5af-4a80-8080-0ce3da526ba3", "name": "Delete Signed Token Key", "request": { "name": "Delete Signed Token Key", "description": { "content": "Deletes the specified signed token key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "keyID", "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "94cb5439-620c-4347-8dd2-5ea35a64c13b", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"keyID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dfb3a48-18e2-4f84-9d5b-e5d0d37133e6", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "734fdde1-1840-464c-9753-9b13e362df37", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b120bcb-5a7d-49a1-af44-b0d83f16b18f", "name": "Get Signed Token Key", "request": { "name": "Get Signed Token Key", "description": { "content": "Returns the specified signed token key.", "type": "text/plain" }, "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "keyID", "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9f6b8e87-34ec-48da-9eb7-1812c9233f63", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"keyID\": \"\",\n \"keyAlgorithm\": \"KEY_ALG_UNSPECIFIED\",\n \"privateKeyData\": \"\",\n \"publicKeyData\": \"iKE5kV615Eaw7Icp\",\n \"validAfterTime\": \"\",\n \"validBeforeTime\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6517eed6-857f-482e-b0f9-8e896e707021", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27304af7-aa52-4a2c-af45-5554d9f9d698", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "serviceAccounts", ":ID", "signedtokenkey", ":keyID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the service account.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" }, { "disabled": false, "description": { "content": "(Required) ID of the signed token key.", "type": "text/plain" }, "type": "any", "value": "", "key": "keyID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Triggers", "description": "", "item": [ { "id": "8d58b910-dbfc-495c-9ed0-6c63db99cc88", "name": "List Triggers", "request": { "name": "List Triggers", "description": { "content": "Retrieves a list of [triggers](/docs/processing/triggers/overview).", "type": "text/plain" }, "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by trigger name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3985d984-32a2-4029-97a5-37018ad2b9eb", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by trigger name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"triggers\": [\n {\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n },\n {\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0761ef00-1602-4dea-94f4-c81bb6962fe4", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by trigger name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd4eca73-b629-47e1-abbe-09d6db239f66", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by trigger name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fe5a9c7-00a5-4b73-850d-72054b054930", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by trigger name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "717e0fb5-8275-408e-8777-301955dbeef6", "name": "Create Trigger", "request": { "name": "Create Trigger", "description": { "content": "Creates a new [trigger](/docs/processing/triggers/overview) to automate actions based on input events.", "type": "text/plain" }, "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ffc476ea-4f20-426b-ad79-2d2ec5d86778", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"triggerID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcb9ac9f-8af7-4a17-8d07-28d6e09e6f6a", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac456554-377f-44ca-b2ab-1095c42c25e6", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53b7d733-8ff0-4d2f-ab67-cae3ca3f80ec", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "triggers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95335ea8-b1f7-41b6-8485-cdf68e3b938b", "name": "Get Trigger", "request": { "name": "Get Trigger", "description": { "content": "Retrieves the specified [trigger](/docs/processing/triggers/overview).", "type": "text/plain" }, "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "triggerID", "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "57232fb8-3e4f-444f-9031-56b31ff87d8f", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c83626f-283c-4f40-9073-95bb9139888b", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf73ac01-17c1-4a9c-9d41-0a7330662683", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f4597bd-0e69-4ccc-bb27-dcb6f515e420", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e989223-2188-4ea6-8517-a5ee5d2d9a89", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "03b1efe0-fafa-4238-bc55-a95960e26c59", "name": "Delete Trigger", "request": { "name": "Delete Trigger", "description": { "content": "Deletes the specified [trigger](/docs/processing/triggers/overview).", "type": "text/plain" }, "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "triggerID", "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "d23a321a-043c-4104-a7b4-c249c90711b5", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"triggerID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da05e0c9-e641-4947-9061-29598924589a", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "005902c9-b50a-4420-8b06-f4c95c80ab72", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f42ca9d-beca-4729-8986-1464858f6dae", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f16c4ba7-6edc-4f10-bac7-d719268f2aab", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1361fefa-6567-4455-9fea-e9bb1f81ff4e", "name": "Update Trigger", "request": { "name": "Update Trigger", "description": { "content": "Updates the specified [trigger](/docs/processing/triggers/overview). Only properties included in the request are updated.", "type": "text/plain" }, "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "triggerID", "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "58670d00-91be-4e9b-8c19-a52ca3c522c8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"triggerID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d35e8bd8-dc6c-4943-b320-6580dfd8577d", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4af65ddb-255b-495d-92c5-b0bf248daf18", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbf8d8e2-b17a-41d1-a11b-804fe281baf0", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2d6b909-075f-481b-bad9-c90637cf57cc", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "triggers", ":triggerID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the trigger.", "type": "text/plain" }, "type": "any", "value": "", "key": "triggerID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"triggerID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"event\": {\n \"type\": \"vaultColumn.updated\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n },\n \"action\": {\n \"type\": \"deidentifyFile.invoke\",\n \"properties\": {\n \"vaultColumn\": {\n \"vaultID\": \"\",\n \"tableName\": \"\",\n \"columnName\": \"\",\n \"skyflowID\": \"\"\n },\n \"deidentifyFile\": {\n \"configID\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Users", "description": "", "item": [ { "id": "bbb6f813-03ca-4e48-bab4-98844acf7250", "name": "List Users", "request": { "name": "List Users", "description": { "content": "Lists users in the account.", "type": "text/plain" }, "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "1e35fa1f-aaa3-4173-a197-a5b954731af8", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"users\": [\n {\n \"userIdentity\": {\n \"email\": \"\",\n \"oktaID\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"ID\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n {\n \"userIdentity\": {\n \"email\": \"\",\n \"oktaID\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"ID\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0a786ec-3074-454d-a454-582783ee8ad9", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6380fdff-76a5-4563-8567-d8ba641d57e9", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc962c22-b58b-47f4-9852-b2bdcfd752e0", "name": "Create User", "request": { "name": "Create User", "description": { "content": "Creates a user.", "type": "text/plain" }, "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6b1c8b4d-4f82-4c9f-86dc-b03bace2b20e", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6a51ab2-e59d-489f-b7d9-ba9eaecce68f", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7b68968-0efc-4898-bdf4-149090c4581f", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4ef4877-8ce5-424d-a488-164bb8ddc82d", "name": "Delete User", "request": { "name": "Delete User", "description": { "content": "Deletes a user.", "type": "text/plain" }, "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "ba26d01f-f6dd-4194-8f43-bee198a91ebd", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72a02f5d-35ce-4baa-95f1-4bd2345b9b44", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d89e653e-208e-4b95-a435-5fe609ccdb11", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d268a514-3012-4260-9fa2-33c8ae76e3d8", "name": "Get User", "request": { "name": "Get User", "description": { "content": "Returns the specified user.", "type": "text/plain" }, "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "577039f8-c153-4610-86bf-a4d49b3bd454", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\",\n \"oktaID\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"ID\": \"\",\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "711f84e4-fd17-498b-9c9b-ee41cf0acd02", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e28d502e-e406-46cd-ab99-796e647ff349", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a2bbab17-0457-42a9-838b-504982bb72fb", "name": "Update User", "request": { "name": "Update User", "description": { "content": "Updates the specified user.", "type": "text/plain" }, "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1bc741f3-f999-469a-b2a0-51240468cf10", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb14a644-ce26-4a7e-89b2-9b10b1856bcd", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "619c8b90-b5cc-41e8-aad1-caae6e58d431", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "users", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the user.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userIdentity\": {\n \"email\": \"\"\n },\n \"name\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Vault Templates", "description": "", "item": [ { "id": "ac061f15-cef0-4768-9c59-5c914de9caa6", "name": "List Vault Templates", "request": { "name": "List Vault Templates", "description": { "content": "Lists the vault templates available to an account.", "type": "text/plain" }, "url": { "path": [ "v1", "vault-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3127c19a-4a92-4f4d-8513-48dfe2dfadcd", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "vault-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"vaultTemplates\": [\n {\n \"ID\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"vaultSchema\": {\n \"schemas\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"parentSchemaProperties\": {\n \"parentID\": \"\",\n \"isArray\": \"\",\n \"tableType\": \"TT_BASE\",\n \"parentFieldTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\"\n },\n \"fields\": [\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n }\n ],\n \"schemaTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n }\n },\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"parentSchemaProperties\": {\n \"parentID\": \"\",\n \"isArray\": \"\",\n \"tableType\": \"TT_BASE\",\n \"parentFieldTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\"\n },\n \"fields\": [\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n }\n ],\n \"schemaTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n }\n }\n ],\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n },\n {\n \"ID\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"vaultSchema\": {\n \"schemas\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"parentSchemaProperties\": {\n \"parentID\": \"\",\n \"isArray\": \"\",\n \"tableType\": \"TT_BASE\",\n \"parentFieldTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\"\n },\n \"fields\": [\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n }\n ],\n \"schemaTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n }\n },\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"parentSchemaProperties\": {\n \"parentID\": \"\",\n \"isArray\": \"\",\n \"tableType\": \"TT_BASE\",\n \"parentFieldTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\"\n },\n \"fields\": [\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n }\n ],\n \"schemaTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n }\n }\n ],\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c624d6a0-2a26-4d7f-a88c-0f92059bb010", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vault-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2542ab9f-adf4-4503-8df8-16f6f44fa18d", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vault-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ec90e2a-716d-42de-83ff-3e35f2a78d51", "name": "Get Vault Template", "request": { "name": "Get Vault Template", "description": { "content": "Returns the specified vault template.", "type": "text/plain" }, "url": { "path": [ "v1", "vault-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the vault template.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b2553c8a-917c-4663-ab20-66288fa5fcb0", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "vault-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault template.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"template\": {\n \"ID\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"vaultSchema\": {\n \"schemas\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"parentSchemaProperties\": {\n \"parentID\": \"\",\n \"isArray\": \"\",\n \"tableType\": \"TT_BASE\",\n \"parentFieldTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\"\n },\n \"fields\": [\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n }\n ],\n \"schemaTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n }\n },\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"parentSchemaProperties\": {\n \"parentID\": \"\",\n \"isArray\": \"\",\n \"tableType\": \"TT_BASE\",\n \"parentFieldTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\"\n },\n \"fields\": [\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"DT_INVALID\",\n \"isArray\": \"\",\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n },\n \"ID\": \"\"\n }\n ],\n \"schemaTags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"properties\": {\n \"name\": \"\",\n \"description\": \"\",\n \"references\": \"\"\n }\n }\n ],\n \"tags\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"namespace\": \"\",\n \"status\": \"NONE\",\n \"displayName\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d869685-b512-48de-bc91-4042cdee7260", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vault-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault template.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcd2cde9-feb8-48fb-8ff0-0954aedd5924", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vault-templates", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault template.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Vaults", "description": "", "item": [ { "id": "9c7875e4-40bf-49cc-bb3d-bbaa88c63feb", "name": "List Vaults", "request": { "name": "List Vaults", "description": { "content": "Lists the vaults you can access in a workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified vault type. (This can only be one of VAULT_TYPE_NONE,SCRATCH_TEMPLATE,QUICKSTART,UI_QUICKSTART,CUSTOMER_IDENTITY,PAYMENT,PII_DATA,PLAID,PAYMENTS_ACCEPTANCE_SAMPLE)", "type": "text/plain" }, "key": "filterOps.type", "value": "QUICKSTART" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "28bc0728-6f60-4269-a203-a150f1289199", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified vault type. (This can only be one of VAULT_TYPE_NONE,SCRATCH_TEMPLATE,QUICKSTART,UI_QUICKSTART,CUSTOMER_IDENTITY,PAYMENT,PII_DATA,PLAID,PAYMENTS_ACCEPTANCE_SAMPLE)", "type": "text/plain" }, "key": "filterOps.type", "value": "QUICKSTART" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"vaults\": [\n {\n \"ID\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"status\": \"RUNNING\",\n \"openapiSpec\": \"\",\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n }\n },\n {\n \"ID\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"status\": \"DELETED\",\n \"openapiSpec\": \"\",\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"EXTERNAL\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c6207fc-8e6e-4f9b-9a22-b60fab1f3b63", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified vault type. (This can only be one of VAULT_TYPE_NONE,SCRATCH_TEMPLATE,QUICKSTART,UI_QUICKSTART,CUSTOMER_IDENTITY,PAYMENT,PII_DATA,PLAID,PAYMENTS_ACCEPTANCE_SAMPLE)", "type": "text/plain" }, "key": "filterOps.type", "value": "QUICKSTART" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed92b998-4013-44d8-9f50-fe447ddeccc0", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified vault type. (This can only be one of VAULT_TYPE_NONE,SCRATCH_TEMPLATE,QUICKSTART,UI_QUICKSTART,CUSTOMER_IDENTITY,PAYMENT,PII_DATA,PLAID,PAYMENTS_ACCEPTANCE_SAMPLE)", "type": "text/plain" }, "key": "filterOps.type", "value": "QUICKSTART" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4dbd911-87ae-479c-804e-6650429c955f", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified vault type. (This can only be one of VAULT_TYPE_NONE,SCRATCH_TEMPLATE,QUICKSTART,UI_QUICKSTART,CUSTOMER_IDENTITY,PAYMENT,PII_DATA,PLAID,PAYMENTS_ACCEPTANCE_SAMPLE)", "type": "text/plain" }, "key": "filterOps.type", "value": "QUICKSTART" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05485b9c-33a6-4f07-8904-3f7281eee6a1", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified vault type. (This can only be one of VAULT_TYPE_NONE,SCRATCH_TEMPLATE,QUICKSTART,UI_QUICKSTART,CUSTOMER_IDENTITY,PAYMENT,PII_DATA,PLAID,PAYMENTS_ACCEPTANCE_SAMPLE)", "type": "text/plain" }, "key": "filterOps.type", "value": "QUICKSTART" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53396034-b024-4bc2-b407-a0ae33dadd51", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that returns only results that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "ARCHIVED" }, { "disabled": true, "description": { "content": "Filter that returns only results that match the specified vault type. (This can only be one of VAULT_TYPE_NONE,SCRATCH_TEMPLATE,QUICKSTART,UI_QUICKSTART,CUSTOMER_IDENTITY,PAYMENT,PII_DATA,PLAID,PAYMENTS_ACCEPTANCE_SAMPLE)", "type": "text/plain" }, "key": "filterOps.type", "value": "QUICKSTART" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbe4c4f3-7d55-44bd-bb48-2afdffecf95e", "name": "Create Vault", "request": { "name": "Create Vault", "description": { "content": "Creates a vault.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n },\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"workspaceID\": \"\",\n \"owners\": [\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n },\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "fedd3bd6-ae36-4598-959b-7d5e624d974c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n },\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"workspaceID\": \"\",\n \"owners\": [\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n },\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "024c8299-505e-4312-b1e8-986c3df1080c", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n },\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"workspaceID\": \"\",\n \"owners\": [\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n },\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ae904c3-645e-4dc5-ae93-095893171105", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n },\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"workspaceID\": \"\",\n \"owners\": [\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n },\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e808d84-2d99-4d1e-b7fb-8800f13095e7", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n },\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"workspaceID\": \"\",\n \"owners\": [\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n },\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3397850b-a270-44f6-8625-12412bdc1526", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n },\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"workspaceID\": \"\",\n \"owners\": [\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n },\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da871a39-aa45-4f1d-a472-9302345bc98e", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n },\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"INTERNAL\"\n },\n \"workspaceID\": \"\",\n \"owners\": [\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n },\n {\n \"serviceAccountInfo\": {\n \"serviceAccount\": {},\n \"clientConfiguration\": {\n \"enforceContextID\": \"\",\n \"enforceSignedDataTokens\": \"\"\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9f6f4bc-922c-406b-a412-a8d4631aacba", "name": "Delete Vault", "request": { "name": "Delete Vault", "description": { "content": "Deletes the specified vault and everything contained within it.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "734c033c-7cfd-421b-b149-bd9db4306925", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cef86ff-9e1f-4e29-9bdb-d0c962dbb00c", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b6fa8a4-568e-4895-b1a2-10d6ec071459", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "388b4edd-c519-4bea-8fba-b38df51ef731", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4211a723-4c1e-45f5-8781-4efae1d70854", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3ca6bc9-9ff7-4e27-a7d0-d8654759c9c7", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "571c5317-948c-4b42-8c9d-f0a63a75d7ba", "name": "Get Vault", "request": { "name": "Get Vault", "description": { "content": "Returns the specified vault.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e87a2f09-4e17-4dcf-b1b3-739eaba3d229", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"vault\": {\n \"ID\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"status\": \"RUNNING\",\n \"openapiSpec\": \"\",\n \"useMasterKey\": {\n \"ID\": \"\",\n \"type\": \"EXTERNAL\"\n }\n },\n \"workspaceID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f800cf29-5af1-4761-8a6a-73368bd9e703", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39cf2ca3-367d-4e90-bacd-3bc6dac1f63c", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e5eae66-5eb7-45a2-a667-a6c308bbbcca", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f5b3977-59c1-4bef-aed5-db1e29a561dc", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b81dc2be-e752-4409-b970-b694e628d01c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "If `true`, only returns the vault ID, name, description, status, namespace, and basic audit metadata.", "type": "text/plain" }, "key": "fetchMetadataOnly", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef347eaa-e396-4468-833b-703d864c5539", "name": "Update Vault", "request": { "name": "Update Vault", "description": { "content": "Updates the specified vault.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e2e88954-54e6-4475-b537-f426234e57ca", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb04e3cd-cd63-478e-8641-69a85b184516", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8833922-24fe-4e83-beac-e1f33e9f5012", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d546c847-7a91-4528-ab88-1469bad22bca", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "298ab209-3827-439a-8af7-117f35849865", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15b8a9cd-1b5d-4f27-a92e-1141cbd52574", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"templateID\": \"\",\n \"vaultSchema\": {\n \"schemas\": [],\n \"tags\": []\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f34a90f3-064a-4c8d-bd20-054aeff97bb5", "name": "List Vault Schema Versions", "request": { "name": "List Vault Schema Versions", "description": { "content": "Returns a list of schema versions for the specified vault.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "4e00d22a-e78c-49b4-96d9-d237a3e821ab", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"schemaVersions\": [\n {\n \"versionTag\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"schemaOperation\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n {\n \"versionTag\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"schemaOperation\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30ac37ac-01d8-453e-8061-580b4fa80dd8", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "760843b7-b991-4a63-a67c-fa765b45de2a", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5513e31-0f87-45c6-9afb-bbe6673089dc", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9233316-38e6-4369-b32e-4304140d1936", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ff993ae-36a6-4eee-ab5b-f0b390623491", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6fee905-6816-4755-9919-75ba6f59dda7", "name": "Get Vault Schema Version", "request": { "name": "Get Vault Schema Version", "description": { "content": "Returns the specified vault schema version.", "type": "text/plain" }, "url": { "path": [ "v1", "vaults", ":vaultID", "versions", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultID", "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "versionTag", "disabled": false, "description": { "content": "(Required) Unique tag of the vault schema version.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a71cadd5-1dd4-4bb5-994d-e4973eb60a40", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Unique tag of the vault schema version.", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"vaultID\": \"\",\n \"versionTag\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"schemaOperation\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8c37cb2-3e0d-40c5-8f9b-63f62ad546eb", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Unique tag of the vault schema version.", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ba839c0-fdac-4f38-ad20-4e50dd3b1b88", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Unique tag of the vault schema version.", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1547f0b9-df75-4dd0-b9b5-7bfe8e9dc330", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Unique tag of the vault schema version.", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3073abd5-c204-4056-b3bb-be16bbccf12a", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Unique tag of the vault schema version.", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b40cd3de-deb7-4c77-9776-568a035620b5", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "vaults", ":vaultID", "versions", ":versionTag" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the vault.", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultID" }, { "disabled": false, "description": { "content": "(Required) Unique tag of the vault schema version.", "type": "text/plain" }, "type": "any", "value": "", "key": "versionTag" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Workspaces", "description": "", "item": [ { "id": "d7e15333-fce6-4f8f-8a84-654f9ecf757c", "name": "List Workspaces", "request": { "name": "List Workspaces", "description": { "content": "Lists the workspaces in an account.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "16b74624-148b-45cd-9d5b-14cb31b193ad", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"workspaces\": [\n {\n \"name\": \"RTCeC6c\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ID\": \"\",\n \"namespace\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n },\n {\n \"name\": \"RGzFvrROB\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ID\": \"\",\n \"namespace\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb1e405e-10c5-4b29-90c0-9f42e8377465", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e452f657-28f5-450e-a54c-9a668664348b", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "status", "value": "NONE" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to retrieve.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa098b89-49f0-473e-9919-8e3cf5acb36c", "name": "Create Workspace", "request": { "name": "Create Workspace", "description": { "content": "Creates a workspace for an account.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"regionID\": \"\",\n \"workspace\": {\n \"name\": \"eTmcF5SGSZ\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n },\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "70f726fd-552a-4db4-8f85-1e0a2b725d33", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"regionID\": \"\",\n \"workspace\": {\n \"name\": \"eTmcF5SGSZ\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n },\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6817243-e954-4ea7-b1a3-55bc64c64025", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"regionID\": \"\",\n \"workspace\": {\n \"name\": \"eTmcF5SGSZ\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n },\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec54dc4e-f069-459a-96fc-6a50e6819d09", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "workspaces" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"regionID\": \"\",\n \"workspace\": {\n \"name\": \"eTmcF5SGSZ\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n },\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e608090-f3af-4767-bbb4-b36c93bb4e43", "name": "Delete Workspace", "request": { "name": "Delete Workspace", "description": { "content": "Deletes the specified Workspace and the entities it contains.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "a1ff364f-7d44-443f-9314-7a27de361e81", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be52cb12-a2a4-40ff-b63e-cbdc2a86bd93", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dc9f171-f773-4451-a450-e84c11a62464", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4ee630f-09af-48d4-8ccb-b985582577a1", "name": "Get Workspace", "request": { "name": "Get Workspace", "description": { "content": "Returns the specified workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "6e59bd52-7a1d-43b8-8791-5f7d6c31634d", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"workspace\": {\n \"name\": \"PnUe5hhkuj\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"ID\": \"\",\n \"namespace\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1905d023-9fa0-481e-bc57-e8d679b0aa0a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2c886ae-7612-4293-bd6b-7151bb8bd278", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e9858644-345d-421f-97e9-0659ba1e498f", "name": "Update Workspace", "request": { "name": "Update Workspace", "description": { "content": "Updates the specified Workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"workspace\": {\n \"name\": \"DFk\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "48e8ba97-353f-4eee-9544-4a18b1004fbc", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"workspace\": {\n \"name\": \"DFk\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f42693d-7d08-4cc1-9a83-a67dff308788", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"workspace\": {\n \"name\": \"DFk\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "290cbe70-72e2-4176-87c7-a09f1afe5d07", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the workspace.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"workspace\": {\n \"name\": \"DFk\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"contactAddress\": {\n \"streetAddress\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"zip\": \"\"\n },\n \"status\": \"NONE\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"type\": \"NONE_TYPE\",\n \"url\": \"\",\n \"limits\": {\n \"vaultCountLimit\": \"\",\n \"vaultSizeLimit\": \"\",\n \"vaultOwnerLimit\": \"\",\n \"permissionRestrictions\": [\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n },\n {\n \"roleName\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"enableExternalSharing\": \"\"\n },\n \"regionID\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b67ccad-8574-4d90-8cb5-21e5e2309e40", "name": "List Members by Workspace", "request": { "name": "List Members by Workspace", "description": { "content": "Lists members for the specified workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "workspaces", ":ID", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "802b91ca-401a-4ac0-b036-3dca23dd6c34", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"members\": [\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n },\n {\n \"ID\": \"\",\n \"type\": \"NONE\",\n \"name\": \"\",\n \"email\": \"\",\n \"status\": \"NONE\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd3f143d-a40b-42ef-b038-7c6d708e8bba", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "951b5434-5721-4c84-ba3d-775b3e487273", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "workspaces", ":ID", "members" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified email address.", "type": "text/plain" }, "key": "filterOps.email", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified type. (This can only be one of NONE,USER,GROUP,SERVICE_ACCOUNT,SQL_SERVICE_ACCOUNT)", "type": "text/plain" }, "key": "filterOps.type", "value": "NONE" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified status. (This can only be one of NONE,CREATED,PENDING,ACTIVE,INACTIVE,ARCHIVED,DELETED)", "type": "text/plain" }, "key": "filterOps.status", "value": "NONE" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Record position at which to start receiving results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the resource. For example, if the resource is `roles`, this field is the role ID. If the resource is `workspaces`, this field is the workspace ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Webhooks", "description": "", "item": [ { "id": "cd957036-8300-4180-a777-aba3e90e8319", "name": "List Webhooks", "request": { "name": "List Webhooks", "description": { "content": "Gets details for multiple [webhooks](/docs/processing/webhooks/overview).", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by webhook name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by endpoint URL.", "type": "text/plain" }, "key": "filterOps.URL", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Number of webhooks to skip before returning results. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of webhooks to return. Defaults to 25, maximum is 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "45790466-7629-4bb1-a866-c0a46940e05e", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by webhook name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by endpoint URL.", "type": "text/plain" }, "key": "filterOps.URL", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Number of webhooks to skip before returning results. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of webhooks to return. Defaults to 25, maximum is 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"webhooks\": [\n {\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ]\n },\n {\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e715d9b-f0b6-43e8-b1bc-a0a0e741988f", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by webhook name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by endpoint URL.", "type": "text/plain" }, "key": "filterOps.URL", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Number of webhooks to skip before returning results. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of webhooks to return. Defaults to 25, maximum is 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f015481-1387-4125-a919-b7ef97f3d9a2", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by webhook name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by endpoint URL.", "type": "text/plain" }, "key": "filterOps.URL", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Number of webhooks to skip before returning results. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of webhooks to return. Defaults to 25, maximum is 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ec65612-8d0c-4a4e-b739-cbaa67ac89d5", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by webhook name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by endpoint URL.", "type": "text/plain" }, "key": "filterOps.URL", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Number of webhooks to skip before returning results. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of webhooks to return. Defaults to 25, maximum is 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57dbab5b-ccda-4055-b8a7-0f7559e8883c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by webhook name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by endpoint URL.", "type": "text/plain" }, "key": "filterOps.URL", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Number of webhooks to skip before returning results. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of webhooks to return. Defaults to 25, maximum is 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46a50724-df96-4415-a46e-c4a1dba572a7", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Filter by webhook name.", "type": "text/plain" }, "key": "filterOps.name", "value": "" }, { "disabled": true, "description": { "content": "Filter by endpoint URL.", "type": "text/plain" }, "key": "filterOps.URL", "value": "" }, { "disabled": true, "description": { "content": "Filter by event types.", "type": "text/plain" }, "key": "filterOps.eventTypes", "value": "" }, { "disabled": true, "description": { "content": "Fully-qualified field by which to sort results. Field names should be in camel case (for example, \"capitalization.camelCase\").", "type": "text/plain" }, "key": "sortOps.sortBy", "value": "" }, { "disabled": true, "description": { "content": "Ascending or descending ordering of results. (This can only be one of ASCENDING,DESCENDING)", "type": "text/plain" }, "key": "sortOps.orderBy", "value": "ASCENDING" }, { "disabled": true, "description": { "content": "Number of webhooks to skip before returning results. Defaults to 0.", "type": "text/plain" }, "key": "offset", "value": "" }, { "disabled": true, "description": { "content": "Maximum number of webhooks to return. Defaults to 25, maximum is 25.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0fae6737-807d-45ea-8304-cf96a7ec724b", "name": "Create Webhook", "request": { "name": "Create Webhook", "description": { "content": "Creates a new [webhook](/docs/processing/webhooks/overview) to notify you about events within Skyflow.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"deidentifyFile.*\",\n \"deidentifyFile.completed\"\n ],\n \"displayName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1767f553-e0a2-41af-ad42-d7d643e54ca5", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"deidentifyFile.*\",\n \"deidentifyFile.completed\"\n ],\n \"displayName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"webhookID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c133978-74b8-498c-ab38-e6831716f297", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"deidentifyFile.*\",\n \"deidentifyFile.completed\"\n ],\n \"displayName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df60d5ab-e768-450f-a8bd-9f0d43e9c14c", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"deidentifyFile.*\",\n \"deidentifyFile.completed\"\n ],\n \"displayName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63be05a1-14c5-4d6e-8758-13a3aa611680", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"deidentifyFile.*\",\n \"deidentifyFile.completed\"\n ],\n \"displayName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ceeee54-2518-4d47-b55e-f78ff4dcc409", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"deidentifyFile.*\",\n \"deidentifyFile.completed\"\n ],\n \"displayName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2523ced-226e-4a41-bcde-02919599faff", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"deidentifyFile.*\",\n \"deidentifyFile.completed\"\n ],\n \"displayName\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "10f5afd5-f092-485f-abd1-fc7ab1c92c5e", "name": "Get Webhook", "request": { "name": "Get Webhook", "description": { "content": "Gets the details of a specific [webhook](/docs/processing/webhooks/overview).", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "webhookID", "disabled": false, "description": { "content": "(Required) ID of the webhook to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e6b85111-fce5-4ecb-927b-4372c9879bd8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"namespace\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e0a3683-d4aa-487e-a38d-236c6b7a48ea", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "317769af-7b48-447c-a88e-0ef508a814ef", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d3f7ad1-4d72-486e-b56d-dd329e6c0094", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b6dfa86-7957-46b4-903c-93a59a867705", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbee61da-e979-48be-b29f-37cd13f96bb9", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2cf980e1-fcf3-47b9-beb9-d100dacee6d1", "name": "Update Webhook", "request": { "name": "Update Webhook", "description": { "content": "Updates the details of a specific [webhook](/docs/processing/webhooks/overview).\nYou only need to include the fields you want to change in the request body. All other fields remain unchanged.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "webhookID", "disabled": false, "description": { "content": "(Required) ID of the webhook to update.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"vaultColumn.*\",\n \"triggerRun.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "189e217b-c72a-42f8-b660-935b97c379db", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"vaultColumn.*\",\n \"triggerRun.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"webhookID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ddd9e91-09db-4dee-9512-1d18c18ee70c", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"vaultColumn.*\",\n \"triggerRun.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2697f3fe-6a56-4ee9-a2ad-56026ecb6a57", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"vaultColumn.*\",\n \"triggerRun.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3ea0b24-6f8c-413e-a04c-61bd52ada6db", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"vaultColumn.*\",\n \"triggerRun.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23d42d22-c1d4-421d-99d9-73b5699cd9a8", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"vaultColumn.*\",\n \"triggerRun.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4d8496b-0ba8-4fd7-a72b-6af052788017", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to update.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"webhookID\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"URL\": \"\",\n \"eventTypes\": [\n \"vaultColumn.*\",\n \"triggerRun.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d6545690-4a51-4afc-8459-0368a92ce15b", "name": "Delete Webhook", "request": { "name": "Delete Webhook", "description": { "content": "Deletes a specific [webhook](/docs/processing/webhooks/overview).", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "webhookID", "disabled": false, "description": { "content": "(Required) ID of the webhook to delete.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "e030f88a-575f-478f-85df-33a75599095a", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"webhookID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dce5a03-1bb2-41df-9874-ccd14015fa60", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "169c44f3-9ba6-4e8f-b135-41993f076add", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d747e3d7-b7d9-41e2-8b59-7ce387323568", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ec83f62-fe8a-41ea-b6c7-c4b4b7f9677c", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0654cecb-b325-4e06-a93a-96e2637da022", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the webhook to delete.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Token Exchange", "description": "", "item": [ { "id": "daa8ac2f-672e-4808-a25c-f573b0b02778", "name": "Get STS Token", "request": { "name": "Get STS Token", "description": { "content": "

Generates a Bearer Token to authenticate with Skyflow. This method doesn't require the Authorization header.

", "type": "text/plain" }, "url": { "path": [ "v1", "auth", "sts", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"service_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ca3a4f2a-8543-47f1-923e-83a450a892a3", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "auth", "sts", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"service_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accessToken\": \"\",\n \"issuedTokenType\": \"\",\n \"tokenType\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38876b2e-f51a-49ba-a5e9-9aa43b00bdda", "name": "Invalid scope format.", "originalRequest": { "url": { "path": [ "v1", "auth", "sts", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"service_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f218a09b-f120-4084-a66f-843bcd6cceca", "name": "Key expired or JWT token unparseable.", "originalRequest": { "url": { "path": [ "v1", "auth", "sts", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"service_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df634161-b3c7-47a2-8604-c5bb57cc0e1a", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "auth", "sts", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"service_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2ef5cb4-7b20-420f-91e5-ed2ef486ea8e", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "auth", "sts", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"\",\n \"subject_token\": \"\",\n \"subject_token_type\": \"\",\n \"service_account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d66044d3-8d5a-461b-a0d2-59e9c30c6feb", "name": "List STS Configs", "request": { "name": "List STS Configs", "description": { "content": "Lists STS configurations for given account", "type": "text/plain" }, "url": { "path": [ "v1", "sts", "config" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "position at which to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3dc4580b-8c25-4b95-ba6c-02d6e55a91d3", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "position at which to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"stsConfigs\": [\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"issuer\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ],\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"accountID\": \"\",\n \"namespace\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n },\n {\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"issuer\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ],\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"accountID\": \"\",\n \"namespace\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f50ad871-59c9-49d5-adac-7ab4a5dfa894", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "sts", "config" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "position at which to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d225584-25aa-4ff7-aef3-ee59e40aa313", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "position at which to start returning results.", "type": "text/plain" }, "key": "offset", "value": "0" }, { "disabled": true, "description": { "content": "Number of results to return.", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": true, "description": { "content": "Filter that limits results to those that match the specified name.", "type": "text/plain" }, "key": "name", "value": "" }, { "disabled": true, "description": { "content": "ID of the account.", "type": "text/plain" }, "key": "accountID", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c433db7d-e245-4780-abac-41f9c60ddb7d", "name": "Create STS Config", "request": { "name": "Create STS Config", "description": { "content": "Creates a new STS configuration", "type": "text/plain" }, "url": { "path": [ "v1", "sts", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuer\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ],\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "66253e7b-5271-4631-b6ad-804a9d18c7ab", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuer\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ],\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "acc85cc6-9b7f-46ce-b350-99a43b870988", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "sts", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuer\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ],\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "478e0e8d-e064-4156-a81f-0b688a3ae2b7", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"issuer\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ],\n \"accountID\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49173e74-da9d-4a42-bcae-c9ff78174138", "name": "Delete STS Config", "request": { "name": "Delete STS Config", "description": { "content": "Deletes an STS configuration", "type": "text/plain" }, "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the STS config to delete", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "4687c18d-a261-48c3-a803-ba9449402f30", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to delete", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "556fb6b4-d508-4788-8aba-cffe49f7248b", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to delete", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17842dcb-d034-41bd-a636-405d0bfd62e3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to delete", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a73f240a-7fa4-4dce-97b9-81dc0dd62b4c", "name": "Get STS Config", "request": { "name": "Get STS Config", "description": { "content": "Fetches an STS configuration by ID", "type": "text/plain" }, "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the STS config to retrieve", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "07d1870e-21a1-4c9e-800a-630a5fee9cde", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"issuer\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ],\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"accountID\": \"\",\n \"namespace\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7449d97b-181f-4d8a-97d4-ca31c4ed9157", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b371debe-62af-454f-87f3-2375ca553e1f", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to retrieve", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fdd4d99-7211-4249-a0a7-d5fb25212b5e", "name": "Update STS Config", "request": { "name": "Update STS Config", "description": { "content": "Updates an existing STS configuration", "type": "text/plain" }, "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the STS config to update", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"issuer\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "7a9ffd50-fc51-4e6f-88bc-4528efebef13", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to update", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"issuer\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"issuer\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ],\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"accountID\": \"\",\n \"namespace\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2938b5b4-6102-4f2e-88f6-2498f9149586", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to update", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"issuer\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a04b4a8-d77f-44fe-8742-8bb8e5dceb29", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "sts", "config", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the STS config to update", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"issuer\": \"\",\n \"publicKeyJWKURI\": \"\",\n \"contextClaims\": [\n \"\",\n \"\"\n ],\n \"serviceAccountIDs\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Detect Configurations V1", "description": "", "item": [ { "id": "e6ba0824-128f-4b2c-bf32-35ccda63aaa6", "name": "Create Detect Configuration", "request": { "name": "Create Detect Configuration", "description": { "content": "Creates a new detect configuration.", "type": "text/plain" }, "url": { "path": [ "v1", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "92d6eef1-1237-4255-8f74-7685ad4225ad", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"configuration_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c60e89b-7a42-4099-a9b3-3e62cab7a7a3", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e117c3bc-4b3f-42c7-82e4-d3f14d2bc946", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "481794bf-d54a-4ee8-b8a6-7509d2a4a7f0", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26fad3c9-41d5-4c21-b965-94438c54f4de", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "561eac20-2f5b-4dec-82cd-f827d806be37", "name": "Get Detect Configuration", "request": { "name": "Get Detect Configuration", "description": { "content": "Returns the specified Detect Configuration.", "type": "text/plain" }, "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "configuration_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "85435eb0-f14c-4715-a82f-f6181fb08fcf", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"config\": {\n \"vault_id\": \"\",\n \"ID\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"entity_types\": [\n \"name\",\n \"origin\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"organization_medical_facility\",\n \"location_state\"\n ],\n \"entity_only\": [\n \"project\",\n \"organization_id\"\n ],\n \"entity_unq_counter\": [\n \"ip_address\",\n \"month\"\n ],\n \"default\": \"entity_only\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dob\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"origin\",\n \"statistics\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"username\",\n \"username\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"none\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"all\",\n \"logo\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "805c393b-c1c1-4a2c-975a-3e67c88bfeaf", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cf4258e-5905-489f-b5fc-32853285679f", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0ccaf0d-9c17-4cb2-b552-05fb7ef979bf", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a2288fb-b80a-4ae7-b5f1-f4c4ddf5c322", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "91c4b296-03ae-4ae3-80d5-6fabef6eb9af", "name": "Update Detect Configuration", "request": { "name": "Update Detect Configuration", "description": { "content": "Updates the specified Detect Configuration.", "type": "text/plain" }, "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "configuration_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "b58a189d-f2b8-4f9a-aa1a-eea2d67d7cb5", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"config\": {\n \"vault_id\": \"\",\n \"ID\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"entity_types\": [\n \"name\",\n \"origin\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"organization_medical_facility\",\n \"location_state\"\n ],\n \"entity_only\": [\n \"project\",\n \"organization_id\"\n ],\n \"entity_unq_counter\": [\n \"ip_address\",\n \"month\"\n ],\n \"default\": \"entity_only\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dob\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"origin\",\n \"statistics\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"username\",\n \"username\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"none\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"all\",\n \"logo\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb81bb44-d045-4d8c-b56a-8c42ddd8ba77", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02d2d913-507b-4420-b80d-3a0b08846b5d", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7096044d-97fc-417e-bb52-7fb28f4d8c61", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bdb042c-ca22-48f2-92fb-8cb10b4d638a", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vault_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"entity_types\": [\n \"event\",\n \"organization_medical_facility\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"physical_attribute\",\n \"time\"\n ],\n \"entity_only\": [\n \"language\",\n \"phone_number\"\n ],\n \"entity_unq_counter\": [\n \"organization\",\n \"account_number\"\n ],\n \"default\": \"vault_token\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"medical_code\",\n \"filename\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"day\",\n \"condition\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"medical_diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e076e54-d5e4-4ee7-9ef8-2d1b253057c1", "name": "Delete Detect Configuration", "request": { "name": "Delete Detect Configuration", "description": { "content": "Deletes the specified Detect Configuration.", "type": "text/plain" }, "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "configuration_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "76f8cdc2-0af9-40c6-8925-cadfdf2e0b45", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bd4bd28-26c4-452a-b52d-0565462c6db1", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fef8af9-d4e7-4aae-982e-b4f60c3ca23d", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f02cf898-1ec7-478c-80ac-497423cc1e77", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38174899-df8e-4f45-bb4e-ae9a237b3fd5", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", ":configuration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configuration_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8fe10524-890d-410f-8de1-4c437b73abd4", "name": "List Detect Configurations", "request": { "name": "List Detect Configurations", "description": { "content": "Returns all Detect Configurations for the vault.", "type": "text/plain" }, "url": { "path": [ "v1", "detect", "configurations", "getAll", ":vault_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vault_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cd836ed5-d558-4049-a179-372a56987b99", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", "getAll", ":vault_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vault_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"configurations\": [\n {\n \"vault_id\": \"\",\n \"ID\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"entity_types\": [\n \"duration\",\n \"name_medical_professional\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"name\",\n \"day\"\n ],\n \"entity_only\": [\n \"location_address_street\",\n \"corporate_action\"\n ],\n \"entity_unq_counter\": [\n \"driver_license\",\n \"numerical_pii\"\n ],\n \"default\": \"entity_unq_counter\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dob\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"location_city\",\n \"dob\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"trend\",\n \"healthcare_number\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"diarized_transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"blackbox\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"face\",\n \"signature\"\n ]\n },\n {\n \"vault_id\": \"\",\n \"ID\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"BasicAudit\": {\n \"CreatedBy\": \"\",\n \"LastModifiedBy\": \"\",\n \"CreatedOn\": \"\",\n \"LastModifiedOn\": \"\"\n },\n \"entity_types\": [\n \"age\",\n \"dob\"\n ],\n \"token_type\": {\n \"vault_token\": [\n \"all\",\n \"origin\"\n ],\n \"entity_only\": [\n \"location_state\",\n \"occupation\"\n ],\n \"entity_unq_counter\": [\n \"all\",\n \"age\"\n ],\n \"default\": \"entity_only\"\n },\n \"transformations\": {\n \"shift_dates\": {\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"entity_types\": [\n \"dat\",\n \"dat\"\n ]\n }\n },\n \"allow_regex\": [\n \"\",\n \"\"\n ],\n \"restrict_regex\": [\n \"\",\n \"\"\n ],\n \"columns_mappings\": [\n {\n \"entity_types\": [\n \"day\",\n \"day\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n {\n \"entity_types\": [\n \"age\",\n \"political_affiliation\"\n ],\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n ],\n \"audio\": {\n \"output_processed_audio\": \"\",\n \"bleep_start_padding\": 0.5,\n \"bleep_stop_padding\": 0.2,\n \"bleep_frequency\": 600,\n \"bleep_gain\": -3,\n \"output_transcription\": \"transcription\"\n },\n \"document\": {\n \"pdf\": {\n \"density\": 200,\n \"max_resolution\": 3000\n }\n },\n \"image\": {\n \"output_processed_image\": \"\",\n \"output_ocr_text\": \"\",\n \"masking_method\": \"none\"\n },\n \"vault_file_mappings\": [\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n },\n {\n \"source_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n },\n \"deidentified_file_location\": {\n \"table_name\": \"\",\n \"column_name\": \"\"\n }\n }\n ],\n \"skip_entities\": \"\",\n \"skip_object_entity_types\": [\n \"all\",\n \"signature\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90b326fe-b687-4840-9af6-5adf98a22a4f", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", "getAll", ":vault_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vault_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "463f381a-fe57-43fe-8cce-3855f2122564", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", "getAll", ":vault_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vault_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56aee332-34f1-4e09-bd3f-c2e5d0ac5eba", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v1", "detect", "configurations", "getAll", ":vault_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vault_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Operations", "description": "", "item": [ { "id": "b9ce8e3e-c91f-4688-bcff-dc6f89ad01b0", "name": "Get Operation Status", "request": { "name": "Get Operation Status", "description": { "content": "Returns the status and details of a specific asynchronous operation.", "type": "text/plain" }, "url": { "path": [ "v2", "operations", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "ID", "disabled": false, "description": { "content": "(Required) ID of the operation.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fe57f2c4-880c-4a18-8402-8c3048b9fb23", "name": "A successful response.", "originalRequest": { "url": { "path": [ "v2", "operations", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the operation.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ID\": \"\",\n \"type\": \"VAULT_TABLE_DELETE\",\n \"status\": \"CREATED\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2c13c04-a074-4494-8dea-4dfabcb035fe", "name": "Returned when the resource does not exist.", "originalRequest": { "url": { "path": [ "v2", "operations", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the operation.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0eaa037-3938-42bb-8eed-1d5b88af29df", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v2", "operations", ":ID" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ID of the operation.", "type": "text/plain" }, "type": "any", "value": "", "key": "ID" } ] }, "header": [ { "disabled": false, "description": { "content": "(Required) ID of the account.", "type": "text/plain" }, "key": "X-Skyflow-Account-ID", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"@type\": \"\",\n \"key_0\": {}\n },\n {\n \"@type\": \"\",\n \"key_0\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Detect Configurations V2", "description": "", "item": [ { "id": "459677bb-a273-4e9c-aa9c-c6384948f47d", "name": "Create Detect Configuration V2", "request": { "name": "Create Detect Configuration V2", "description": { "content": "Creates a new detect configuration.

Note: V2 API is in beta and feature-flagged.", "type": "text/plain" }, "url": { "path": [ "v2", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f1542fdd-0d16-4295-8755-94bbe3cbd6e7", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"configurationId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1f2bc88-7557-4bc9-aac6-b9bdbe943b57", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c4e0aa6-abf7-47fa-8508-0ed7d166eb09", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9f05fcb-40a1-469a-9168-c8085dd611a5", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f16e219f-802b-41ee-904e-063fadbd3076", "name": "List Detect Configurations V2", "request": { "name": "List Detect Configurations V2", "description": { "content": "Returns all Detect Configurations for the vault.

Note: V2 API is in beta and feature-flagged.", "type": "text/plain" }, "url": { "path": [ "v2", "detect", "configurations", "vaults", ":vaultId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "vaultId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "e440025f-572f-4e60-aaba-38970ac585f7", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", "vaults", ":vaultId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"configurations\": [\n {\n \"vaultId\": \"\",\n \"ID\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"vaultType\": \"PRIVACYDB\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n },\n {\n \"vaultId\": \"\",\n \"ID\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"vaultType\": \"PRIVACYDB\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d912586-f3bc-4149-94e5-8074102d70aa", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", "vaults", ":vaultId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9ab8a8d-163c-4aba-9b39-6d90f9682495", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", "vaults", ":vaultId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2819e0e-18fc-405d-9dd0-24092b554005", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", "vaults", ":vaultId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "vaultId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "254628b4-b862-47ac-b544-074ae16229ba", "name": "Get Detect Configuration V2", "request": { "name": "Get Detect Configuration V2", "description": { "content": "Returns the specified Detect Configuration.

Note: V2 API is in beta and feature-flagged.", "type": "text/plain" }, "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "configurationId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0325498b-a5c2-46f5-9837-a6b97a021d91", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"config\": {\n \"vaultId\": \"\",\n \"ID\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"vaultType\": \"FLOWDB\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "448aeb47-87ae-43ae-a638-c117ce4f51d0", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a336d1f8-2736-40e8-b182-944224bb3a85", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49a888b-eab4-453e-bc3d-80b1d50dba4b", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2af82d5-c5e7-47fa-ba41-aba042e9e1ae", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "336239d2-c045-4311-b3bb-3150af9507cb", "name": "Update Detect Configuration V2", "request": { "name": "Update Detect Configuration V2", "description": { "content": "Updates the specified Detect Configuration.

Note: V2 API is in beta and feature-flagged.", "type": "text/plain" }, "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "configurationId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "ef75d1fb-3c4e-43a8-be80-231dddf10181", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"config\": {\n \"vaultId\": \"\",\n \"ID\": \"\",\n \"name\": \"\",\n \"namespace\": \"\",\n \"description\": \"\",\n \"vaultType\": \"FLOWDB_SCHEMALESS\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c06d7b40-1575-49e4-a95c-4f22de8a6726", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67c55362-0e1a-42d4-bef6-c6d0063407e6", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25e6bffe-e5a5-4f18-9318-b21a4368dcf3", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"vaultId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"detect\": {\n \"entities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"ENTITY_UNIQUE_COUNTER\",\n \"destination\": \"\",\n \"transformation\": {\n \"shiftDates\": {\n \"minDays\": \"\",\n \"maxDays\": \"\"\n }\n }\n }\n ],\n \"objectEntities\": [\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n },\n {\n \"entityType\": \"ALL\",\n \"deidentificationType\": \"UNREDACT\"\n }\n ],\n \"restrict\": [\n \"\",\n \"\"\n ],\n \"skip\": [\n \"\",\n \"\"\n ],\n \"customTypes\": [\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"match\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"returnEntities\": \"EXCLUDE_SENSITIVE_DATA\"\n },\n \"fileMapping\": [\n {\n \"source\": \"\",\n \"destination\": \"\"\n },\n {\n \"source\": \"\",\n \"destination\": \"\"\n }\n ],\n \"media\": {\n \"audio\": {\n \"outputProcessedAudio\": true,\n \"outputTranscription\": \"NONE\",\n \"bleep\": {\n \"startPadding\": 0.5,\n \"stopPadding\": 0.2,\n \"frequency\": 600,\n \"gain\": -3\n }\n },\n \"document\": {\n \"pdf\": {\n \"processingMode\": \"TEXT_LAYER\",\n \"density\": 200,\n \"maxResolution\": 3000\n }\n },\n \"image\": {\n \"outputProcessedImage\": true,\n \"outputOcrText\": false,\n \"maskingMethod\": \"BLACKBOX\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1baa3ee-fc40-44d6-bd0d-909c50d16715", "name": "Delete Detect Configuration V2", "request": { "name": "Delete Detect Configuration V2", "description": { "content": "Deletes the specified Detect Configuration.

Note: V2 API is in beta and feature-flagged.", "type": "text/plain" }, "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "configurationId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "a42f199c-7d0b-4d28-86f9-49adcb39a412", "name": "OK", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"configurationId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16b0d9ff-569d-41e6-888d-a569db130c3e", "name": "Returned when the request is invalid or cannot be served.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61917b9d-cdd2-4ab2-a223-60133087a25c", "name": "Returned when the request is unauthorized.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f612ca9-4ef1-4598-9adc-c03d2dacc7cb", "name": "Returned when a resource doesn't exist.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be4fe3ea-994e-4c06-be5c-243a7ff18b87", "name": "An unexpected error response.", "originalRequest": { "url": { "path": [ "v2", "detect", "configurations", ":configurationId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "configurationId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "x-request-id", "value": "" }, { "disabled": true, "description": { "content": "", "type": "text/plain" }, "key": "X-Request-ID", "value": "" } ], "body": "{\n \"error\": {\n \"grpc_code\": \"\",\n \"http_code\": \"\",\n \"http_status\": \"\",\n \"message\": \"\",\n \"details\": [\n {\n \"key_0\": 4845,\n \"key_1\": 6288\n },\n {\n \"key_0\": 1104,\n \"key_1\": 1022\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [], "variable": [ { "key": "token", "value": "", "type": "string" }, { "key": "accountID", "value": "", "type": "string" }, { "key": "baseUrl", "value": "" } ], "info": { "_postman_id": "5e82c15b-9eee-41b4-9350-f708ffd0ff8c", "name": "Management API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "This API controls aspects of your account and schema, including workspaces, vaults, keys, users, permissions, and more.\n\nThe Management API is available from two base URIs:\n\n- **Sandbox:** https://manage.skyflowapis-preview.com\n- **Production:** https://manage.skyflowapis.com\n\nWhen you make an API call, you need to add two headers:\n\n| Header | Value | Example |\n| --- | --- | --- |\n| Authorization | A Bearer Token. See [API Authentication](/docs/fundamentals/api-authentication). | `Authorization: Bearer eyJhbGciOiJSUzI...1NiIsJdfPA` |\n| X-Skyflow-Account-ID | Your Skyflow account ID. | `X-Skyflow-Account-ID: h451b763713e4424a7jke1bbkbbc84ef` |\n\nContact Support:\n Name: Skyflow\n Email: support@skyflow.com", "type": "text/plain" } } }