@itentialopensource/adapter-paloalto_prismacloud

{ "id": "@itentialopensource/adapter-paloalto_prismacloud", "type": "Adapter", "export": "Prismacloud", "title": "Prismacloud", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "loginGenerateToken", "summary": "Login Generate Token", "description": "Returns a JWT auth token for accessing the Prisma Cloud APIs. To generate a token, you must have an access key and include the following values in the request body parameter — access key ID as the username and your secret key as the password. Prisma Cloud requires this JWT in the request header to authorize API access.", "input": [ { "name": "body", "type": "object", "info": ": {\"username\": \"string\", \"password\": \"string\"}", "required": true, "schema": { "title": "LoginGenerateTokenRequest", "required": [ "username", "password" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "example": { "username": "{{ACCESS_KEY}}", "password": "{{SECRET_KEY}}" } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/loginGenerateToken" }, "task": true }, { "name": "refreshToken", "summary": "Refresh Token", "description": "Extend a user's session. The JWT token returned is valid until the next session timeout occurs. This method requires a valid session token to be passed (token from a prior successful extend or login calls).", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/refreshToken" }, "task": true }, { "name": "updateSSOBypassAllowedUsers", "summary": "Update SSO Bypass Allowed Users", "description": "Update the list of which users are allowed to bypass SSO and sign in to Prisma Cloud directly.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/updateSSOBypassAllowedUsers" }, "task": true }, { "name": "profile", "summary": "Profile", "description": "Returns the information about the current authenticated user/access-key.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/profile" }, "task": true }, { "name": "updateProfile", "summary": "Update Profile", "description": "Updates the current authenticated user/access-key account information.", "input": [ { "name": "body", "type": "object", "info": ": {\"email\": \"string\", \"firstName\": \"string\", \"lastName\": \"string\", \"timeZone\": \"string\", \"roleId\": \"string\", \"accessKeysAllowed\": \"boolean\", \"onlyAllowCIAccess\": \"boolean\", \"onlyAllowComputeAccess\": \"boolean\"}", "required": true, "schema": { "title": "UpdateProfileRequest", "required": [ "email", "firstName", "lastName", "timeZone", "roleId", "accessKeysAllowed", "onlyAllowCIAccess", "onlyAllowComputeAccess" ], "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "timeZone": { "type": "string" }, "roleId": { "type": "string" }, "accessKeysAllowed": { "type": "boolean" }, "onlyAllowCIAccess": { "type": "boolean" }, "onlyAllowComputeAccess": { "type": "boolean" } }, "example": { "email": "email_to_update", "firstName": "first", "lastName": "last", "timeZone": "America/New_York", "roleId": "ROLE_ID_HERE", "accessKeysAllowed": true, "onlyAllowCIAccess": true, "onlyAllowComputeAccess": true } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateProfile" }, "task": true }, { "name": "listUsers", "summary": "List Users", "description": "List all users in the current Prisma Cloud tenant.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listUsers" }, "task": true }, { "name": "addNewUserProfilev2", "summary": "Add New User Profile v2", "description": "Creates a new users profile. You need to query a valid ROLE_ID before executing here with a List User Roles GET call.", "input": [ { "name": "body", "type": "object", "info": ": {\"roleIds\": \"array\", \"email\": \"string\", \"firstName\": \"string\", \"lastName\": \"string\", \"timeZone\": \"string\", \"accessKeysAllowed\": \"boolean\", \"defaultRoleId\": \"string\"}", "required": true, "schema": { "title": "AddNewUserProfilev2Request", "required": [ "roleIds", "email", "firstName", "lastName", "timeZone", "accessKeysAllowed", "defaultRoleId" ], "type": "object", "properties": { "roleIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "timeZone": { "type": "string" }, "accessKeysAllowed": { "type": "boolean" }, "defaultRoleId": { "type": "string" } }, "example": { "roleIds": [ "ROLE_IDs_HERE" ], "email": "NEW_USER_EMAIL", "firstName": "FIRST_NAME", "lastName": "LAST_NAME", "timeZone": "GMT", "accessKeysAllowed": true, "defaultRoleId": "DEFAULT_ROLE_ID" } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addNewUserProfilev2" }, "task": true }, { "name": "listUsernames", "summary": "List Usernames", "description": "List all usernames in the current Prisma Cloud tenant.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listUsernames" }, "task": true }, { "name": "listUserRoleType", "summary": "List User Role Type", "description": "List user roles for the current Prisma Cloud tenant.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listUserRoleType" }, "task": true }, { "name": "getUsersProfileOtherthanyourown", "summary": "Get Users Profile (other than your own)", "description": "Returns the information about a specific user/accounts information.", "input": [ { "name": "emailId", "type": "string", "info": ": string", "required": true, "schema": { "title": "emailId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersProfileOtherthanyourown" }, "task": true }, { "name": "updateUserProfileOtherthanyourown", "summary": "Update User Profile (other than your own)", "description": "Updates the information of a specific user/account.", "input": [ { "name": "emailId", "type": "string", "info": ": string", "required": true, "schema": { "title": "emailId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateUserProfileOtherthanyourown" }, "task": true }, { "name": "deleteUserProfile", "summary": "Delete User Profile", "description": "Extend a user's session. The JWT token returned is valid until the next session timeout occurs. This method requires a valid session token to be passed (token from a prior successful extend or login calls).", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteUserProfile" }, "task": true }, { "name": "updateUserStatus", "summary": "Update User Status", "description": "Enables or disables a specific users login status.", "input": [ { "name": "emailId", "type": "string", "info": ": string", "required": true, "schema": { "title": "emailId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateUserStatus" }, "task": true }, { "name": "listEmailDomains", "summary": "List Email Domains", "description": "List all domains any user accounts have within the current Prisma Cloud tenant.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listEmailDomains" }, "task": true }, { "name": "listSSOBypassAllowedUsers", "summary": "List SSO Bypass Allowed Users", "description": "List current user accounts that are allowed to bypass SSO and sign in to Prisma Cloud directly.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listSSOBypassAllowedUsers" }, "task": true }, { "name": "listUserRoles", "summary": "List User Roles", "description": "Lists all accounts and associated Roles in the current Prisma Cloud tenant.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listUserRoles" }, "task": true }, { "name": "addUserRole", "summary": "Add User Role", "description": "Adds a new User Role, much be combined with Account Group ID from \"List Account Groups\" GET.\nAlso needs to match a corresponding \"Permission Group\" from within Prisma Cloud.", "input": [ { "name": "body", "type": "object", "info": ": {\"accountGroupIds\": \"array\", \"name\": \"string\", \"description\": \"string\", \"roleType\": \"string\", \"restrictDismissalAccess\": \"boolean\", \"additionalAttributes\": {\"onlyAllowCIAccess\": \"boolean\", \"onlyAllowComputeAccess\": \"boolean\"}}", "required": true, "schema": { "title": "AddUserRoleRequest", "required": [ "accountGroupIds", "name", "description", "roleType", "restrictDismissalAccess", "additionalAttributes" ], "type": "object", "properties": { "accountGroupIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "name": { "type": "string" }, "description": { "type": "string" }, "roleType": { "type": "string" }, "restrictDismissalAccess": { "type": "boolean" }, "additionalAttributes": { "title": "AdditionalAttributes", "required": [ "onlyAllowCIAccess", "onlyAllowComputeAccess" ], "type": "object", "properties": { "onlyAllowCIAccess": { "type": "boolean" }, "onlyAllowComputeAccess": { "type": "boolean" } }, "example": { "onlyAllowCIAccess": false, "onlyAllowComputeAccess": false } } }, "example": { "accountGroupIds": [ "ACCOUNT_GROUP_ID" ], "name": "ROLE_NAME", "description": "Role Description", "roleType": "PERMISSION_GROUP_NAME", "restrictDismissalAccess": false, "additionalAttributes": { "onlyAllowCIAccess": false, "onlyAllowComputeAccess": false } } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addUserRole" }, "task": true }, { "name": "listUserRoleNames", "summary": "List User Role Names", "description": "Returns list of user role IDs and names.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/listUserRoleNames" }, "task": true }, { "name": "userRoleInfo", "summary": "User Role Info", "description": "Retrieve all information about an user role using its ID.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/userRoleInfo" }, "task": true }, { "name": "updateUserRole", "summary": "Update User Role", "description": "Updates a specific user role based upon ID.", "input": [ { "name": "body", "type": "object", "info": ": {\"name\": \"string\", \"description\": \"string\", \"roleType\": \"string\", \"accountGroupIds\": \"array\", \"resourceListIds\": \"array\", \"associatedUsers\": \"array\", \"restrictDismissalAccess\": \"boolean\", \"additionalAttributes\": {\"onlyAllowCIAccess\": \"boolean\", \"onlyAllowComputeAccess\": \"boolean\", \"hasDefenderPermissions\": \"boolean\", \"onlyAllowReadAccess\": \"boolean\"}}", "required": true, "schema": { "title": "UpdateUserRoleRequest", "required": [ "name", "description", "roleType", "accountGroupIds", "resourceListIds", "associatedUsers", "restrictDismissalAccess", "additionalAttributes" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "roleType": { "type": "string" }, "accountGroupIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "resourceListIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "associatedUsers": { "type": "array", "items": { "type": "string" }, "description": "" }, "restrictDismissalAccess": { "type": "boolean" }, "additionalAttributes": { "title": "AdditionalAttributes1", "required": [ "onlyAllowCIAccess", "onlyAllowComputeAccess", "hasDefenderPermissions", "onlyAllowReadAccess" ], "type": "object", "properties": { "onlyAllowCIAccess": { "type": "boolean" }, "onlyAllowComputeAccess": { "type": "boolean" }, "hasDefenderPermissions": { "type": "boolean" }, "onlyAllowReadAccess": { "type": "boolean" } }, "example": { "onlyAllowCIAccess": false, "onlyAllowComputeAccess": false, "hasDefenderPermissions": false, "onlyAllowReadAccess": false } } }, "example": { "name": "ROLE_NAME", "description": "Role Description", "roleType": "PERMISSION_GROUP_NAME", "accountGroupIds": [ "ACCOUNT_GROUP_ID" ], "resourceListIds": [ "RESOURCE_LIST_IDS" ], "associatedUsers": [ "ASSOCIATED_USERS" ], "restrictDismissalAccess": false, "additionalAttributes": { "onlyAllowCIAccess": false,