@itentialopensource/adapter-zscaler

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/authenticatedSession": { "get": { "tags": [ "Authentication" ], "operationId": "getAuthenticatedSession", "description": "The parameters and request body are for method: getAuthenticatedSession. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "authType": { "type": "string" }, "obfuscateApiKey": { "type": "boolean" }, "passwordExpiryTime": { "type": "number" }, "passwordExpiryDays": { "type": "number" } } }, "example": { "authType": "SUPPORT_ACCESS_FULL", "obfuscateApiKey": false, "passwordExpiryTime": 2, "passwordExpiryDays": 8 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Authentication" ], "operationId": "postAuthenticatedSession", "description": "The parameters and request body are for method: postAuthenticatedSession. Same endpoint also used in methods: postAuthenticatedSession__v1 (iapMetadata : object) postAuthenticatedSession__v2 (iapMetadata : object) postAuthenticatedSession__v3 (iapMetadata : object) postAuthenticatedSession__v4 (iapMetadata : object) postAuthenticatedSession__v5 (iapMetadata : object) postAuthenticatedSession__v6 (iapMetadata : object)", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "authType": { "type": "string" }, "obfuscateApiKey": { "type": "boolean" }, "passwordExpiryTime": { "type": "number" }, "passwordExpiryDays": { "type": "number" } } }, "example": { "authType": "ADMIN_SAML_SSO_LOGIN", "obfuscateApiKey": false, "passwordExpiryTime": 3, "passwordExpiryDays": 10 } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "credentials" } } } }, "delete": { "tags": [ "Authentication" ], "operationId": "deleteAuthenticatedSession", "description": "The parameters and request body are for method: deleteAuthenticatedSession. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" } } }, "example": { "status": "INPROGRESS" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/auditReport": { "get": { "tags": [ "AdminAuditLogs" ], "operationId": "getAuditReport", "description": "The parameters and request body are for method: getAuditReport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "progressItemsComplete": { "type": "number" }, "progressEndTime": { "type": "number" }, "errorCode": { "type": "string" } } }, "example": { "status": "CANCELLED", "progressItemsComplete": 9, "progressEndTime": 2, "errorCode": "INVALID_USERNAME_OR_PASSWORD" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AdminAuditLogs" ], "operationId": "postAuditReport", "description": "The parameters and request body are for method: postAuditReport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "AdminAuditLogs" ], "operationId": "deleteAuditReport", "description": "The parameters and request body are for method: deleteAuditReport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/auditReport/download": { "get": { "tags": [ "AdminAuditLogs" ], "operationId": "getAuditReportdownload", "description": "The parameters and request body are for method: getAuditReportdownload. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/auditlogEntryReport": { "get": { "tags": [ "AdminAuditLogs" ], "operationId": "getAuditlogEntryReport", "description": "The parameters and request body are for method: getAuditlogEntryReport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "progressItemsComplete": { "type": "number" }, "progressEndTime": { "type": "number" }, "errorCode": { "type": "string" } } }, "example": { "status": "COMPLETE", "progressItemsComplete": 8, "progressEndTime": 7, "errorCode": "CENTRAL_AUTHORITY_CONNECTION_CLOSED" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "AdminAuditLogs" ], "operationId": "postAuditlogEntryReport", "description": "The parameters and request body are for method: postAuditlogEntryReport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "request" } } } }, "delete": { "tags": [ "AdminAuditLogs" ], "operationId": "deleteAuditlogEntryReport", "description": "The parameters and request body are for method: deleteAuditlogEntryReport. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/auditlogEntryReport/download": { "get": { "tags": [ "AdminAuditLogs" ], "operationId": "getAuditlogEntryReportdownload", "description": "The parameters and request body are for method: getAuditlogEntryReportdownload. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/departments": { "get": { "tags": [ "UserManagement" ], "operationId": "getDepartments", "description": "The parameters and request body are for method: getDepartments. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" }, "deleted": { "type": "boolean" } } } }, "example": [ { "id": 3, "name": "string", "comments": "string", "deleted": true } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/departments/{id}": { "get": { "tags": [ "UserManagement" ], "operationId": "getDepartmentsid", "description": "The parameters and request body are for method: getDepartmentsid. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" }, "deleted": { "type": "boolean" } } }, "example": { "id": 9, "name": "string", "comments": "string", "deleted": true } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/groups": { "get": { "tags": [ "UserManagement" ], "operationId": "getGroups", "description": "The parameters and request body are for method: getGroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" } } } }, "example": [ { "id": 6, "name": "string", "comments": "string" }, { "id": 10, "name": "string", "comments": "string" }, { "id": 10, "name": "string", "comments": "string" }, { "id": 2, "name": "string", "comments": "string" } ] } } } }, "parameters": [ { "name": "search", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/groups/{groupId}": { "get": { "tags": [ "UserManagement" ], "operationId": "getGroupsgroupId", "description": "The parameters and request body are for method: getGroupsgroupId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" } } }, "example": { "id": 5, "name": "string", "comments": "string" } } } } }, "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "title": "groupId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/users": { "get": { "tags": [ "UserManagement" ], "operationId": "getUsers", "description": "The parameters and request body are for method: getUsers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" } } } }, "department": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" }, "deleted": { "type": "boolean" } } } }, "comments": { "type": "string" }, "tempAuthEmail": { "type": "string" }, "password": { "type": "string" }, "adminUser": { "type": "boolean" }, "type": { "type": "string" } } } }, "example": [ { "id": 10, "name": "string", "email": "string", "groups": [ { "id": 8, "name": "string", "comments": "string" }, { "id": 9, "name": "string", "comments": "string" }, { "id": 7, "name": "string", "comments": "string" }, { "id": 7, "name": "string", "comments": "string" }, { "id": 6, "name": "string", "comments": "string" }, { "id": 5, "name": "string", "comments": "string" }, { "id": 8, "name": "string", "comments": "string" }, { "id": 2, "name": "string", "comments": "string" }, { "id": 8, "name": "string", "comments": "string" }, { "id": 2, "name": "string", "comments": "string" } ], "department": [ { "id": 10, "name": "string", "comments": "string", "deleted": false }, { "id": 7, "name": "string", "comments": "string", "deleted": false }, { "id": 4, "name": "string", "comments": "string", "deleted": false }, { "id": 4, "name": "string", "comments": "string", "deleted": true }, { "id": 5, "name": "string", "comments": "string", "deleted": false }, { "id": 2, "name": "string", "comments": "string", "deleted": false }, { "id": 8, "name": "string", "comments": "string", "deleted": true } ], "comments": "string", "tempAuthEmail": "string", "password": "string", "adminUser": true, "type": "SUPERADMIN" } ] } } } }, "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "dept", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "group", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "UserManagement" ], "operationId": "postUsers", "description": "The parameters and request body are for method: postUsers. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" } } } }, "department": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" }, "deleted": { "type": "boolean" } } } }, "comments": { "type": "string" }, "tempAuthEmail": { "type": "string" }, "password": { "type": "string" }, "adminUser": { "type": "boolean" }, "type": { "type": "string" } } }, "example": { "id": 4, "name": "string", "email": "string", "groups": [ { "id": 6, "name": "string", "comments": "string" }, { "id": 8, "name": "string", "comments": "string" }, { "id": 3, "name": "string", "comments": "string" } ], "department": [ { "id": 2, "name": "string", "comments": "string", "deleted": false }, { "id": 10, "name": "string", "comments": "string", "deleted": true }, { "id": 1, "name": "string", "comments": "string", "deleted": true }, { "id": 7, "name": "string", "comments": "string", "deleted": false } ], "comments": "string", "tempAuthEmail": "string", "password": "string", "adminUser": false, "type": "UNAUTH_TRAFFIC_DEFAULT" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "user" } } } } }, "/users/bulkDelete": { "post": { "tags": [ "UserManagement" ], "operationId": "postUsersbulkDelete", "description": "The parameters and request body are for method: postUsersbulkDelete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "object" } } } }, "example": { "ids": [ {}, {}, {}, {} ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "userIds" } } } } }, "/users/{userId}": { "get": { "tags": [ "UserManagement" ], "operationId": "getUsersuserId", "description": "The parameters and request body are for method: getUsersuserId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" } } } }, "department": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" }, "deleted": { "type": "boolean" } } } }, "comments": { "type": "string" }, "tempAuthEmail": { "type": "string" }, "password": { "type": "string" }, "adminUser": { "type": "boolean" }, "type": { "type": "string" } } }, "example": { "id": 3, "name": "string", "email": "string", "groups": [ { "id": 4, "name": "string", "comments": "string" }, { "id": 2, "name": "string", "comments": "string" }, { "id": 9, "name": "string", "comments": "string" }, { "id": 4, "name": "string", "comments": "string" }, { "id": 9, "name": "string", "comments": "string" }, { "id": 8, "name": "string", "comments": "string" }, { "id": 4, "name": "string", "comments": "string" }, { "id": 10, "name": "string", "comments": "string" }, { "id": 7, "name": "string", "comments": "string" } ], "department": [ { "id": 10, "name": "string", "comments": "string", "deleted": true }, { "id": 6, "name": "string", "comments": "string", "deleted": true }, { "id": 2, "name": "string", "comments": "string", "deleted": false }, { "id": 2, "name": "string", "comments": "string", "deleted": true }, { "id": 10, "name": "string", "comments": "string", "deleted": true } ], "comments": "string", "tempAuthEmail": "string", "password": "string", "adminUser": false, "type": "REPORT_USER" } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "UserManagement" ], "operationId": "putUsersuserId", "description": "The parameters and request body are for method: putUsersuserId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" } } } }, "department": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "comments": { "type": "string" }, "deleted": { "type": "boolean" } } } }, "comments": { "type": "string" }, "tempAuthEmail": { "type": "string" }, "password": { "type": "string" }, "adminUser": { "type": "boolean" }, "type": { "type": "string" } } }, "example": { "id": 7, "name": "string", "email": "string", "groups": [ { "id": 6, "name": "string", "comments": "string" }, { "id": 4, "name": "string", "comments": "string" }, { "id": 10, "name": "string", "comments": "string" }, { "id": 10, "name": "string", "comments": "string" }, { "id": 3, "name": "string", "comments": "string" }, { "id": 10, "name": "string", "comments": "string" } ], "department": [ { "id": 9, "name": "string", "comments": "string", "deleted": false }, { "id": 10, "name": "string", "comments": "string", "deleted": false }, { "id": 8, "name": "string", "comments": "string", "deleted": false }, { "id": 5, "name": "string", "comments": "string", "deleted": true } ], "comments": "string", "tempAuthEmail": "string", "password": "string", "adminUser": true, "type": "AUDITOR" } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "user" } } } }, "delete": { "tags": [ "UserManagement" ], "operationId": "deleteUsersuserId", "description": "The parameters and request body are for method: deleteUsersuserId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "title": "userId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/security": { "get": { "tags": [ "SecurityPolicySettings" ], "operationId": "getSecurity", "description": "The parameters and request body are for method: getSecurity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "whitelistUrls": { "type": "array", "items": { "type": "string" } } } }, "example": { "whitelistUrls": [ "string", "string" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SecurityPolicySettings" ], "operationId": "putSecurity", "description": "The parameters and request body are for method: putSecurity. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "whitelistUrls": { "type": "array", "items": { "type": "string" } } } }, "example": { "whitelistUrls": [ "string", "string", "string", "string", "string" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "policy" } } } } }, "/security/advanced": { "get": { "tags": [ "SecurityPolicySettings" ], "operationId": "getSecurityadvanced", "description": "The parameters and request body are for method: getSecurityadvanced. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "blacklistUrls": { "type": "array", "items": { "type": "string" } } } }, "example": { "blacklistUrls": [ "string", "string", "string" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "SecurityPolicySettings" ], "operationId": "putSecurityadvanced", "description": "The parameters and request body are for method: putSecurityadvanced. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "blacklistUrls": { "type": "array", "items": { "type": "string" } } } }, "example": {