{ "workflow": { "unique_name": "definition_workflow_01JAL22JA2KDM70amrajus8K4adt80jPl6C", "name": "Umbrella - Reporting v2 - Get Token - MSSP Adjusted", "title": "Umbrella - Reporting v2 - Get Token - MSSP Adjusted", "type": "generic.workflow", "base_type": "workflow", "variables": [ { "schema_id": "datatype.secure_string", "properties": { "value": "", "scope": "output", "name": "Access Token", "type": "datatype.secure_string", "description": "The bearer token for subsequent API requests", "is_required": false, "is_invisible": false }, "unique_name": "variable_workflow_01JAL4N53R4SK3xdy9WH4uXGM8tGXCh87xF", "object_type": "variable_workflow" }, { "schema_id": "datatype.integer", "properties": { "value": 0, "scope": "output", "name": "Expires In", "type": "datatype.integer", "description": "How many seconds until the access token expires", "is_required": false, "is_invisible": false }, "unique_name": "variable_workflow_01JAMJ6TDDRHK7Mn9TpShs327XWNkRihacu", "object_type": "variable_workflow" }, { "schema_id": "datatype.string", "properties": { "value": "", "scope": "input", "name": "Encoded_API_key", "type": "datatype.string", "is_required": false, "is_invisible": false }, "unique_name": "variable_workflow_01OIIJWJJ1LQS70bGCLmBGjNagXZSEnxvHz", "object_type": "variable_workflow" } ], "properties": { "atomic": { "atomic_group": "Cisco Umbrella", "is_atomic": true }, "delete_workflow_instance": false, "description": "Gets an OAuth2 token for the Umbrella v2 API using a client ID and secret.\n\nTarget: HTTP endpoint for \"management.api.umbrella.com\"\n\nAccount Key: HTTP basic with Umbrella Reporting API key (client ID as username, client secret as password)\n\nSteps:\n[] Make the API request to get a token\n[] Check if the API request succeeded:\n[]> If it did, attempt to extract the bearer token and expiration time and set the workflow's output variables\n[]> If it didn't, output an error", "display_name": "Umbrella - Reporting v2 - Get Token - MSSP Adjusted", "runtime_user": { "override_target_runtime_user": false, "specify_on_workflow_start": false, "target_default": true }, "target": { "target_type": "web-service.endpoint", "specify_on_workflow_start": true } }, "object_type": "definition_workflow", "actions": [ { "unique_name": "definition_activity_01JAL42HEX0QQ7NMNO7XJ4rC0EveK18kcam", "name": "HTTP Request", "title": "Request token", "type": "web-service.http_request", "base_type": "activity", "properties": { "action_timeout": 180, "allow_auto_redirect": true, "continue_on_error_status_code": true, "continue_on_failure": false, "custom_headers": [ { "name": "Authorization", "value": "Basic $workflow.definition_workflow_01JAL22JA2KDM70amrajus8K4adt80jPl6C.input.variable_workflow_01OIIJWJJ1LQS70bGCLmBGjNagXZSEnxvHz$" } ], "display_name": "Request token", "method": "GET", "relative_url": "auth/v2/oauth2/token", "runtime_user": { "override_target_runtime_user": false, "target_default": true }, "skip_execution": false, "target": { "override_workflow_target": false, "override_workflow_target_group_criteria": false, "use_workflow_target": true, "use_workflow_target_group": false } }, "object_type": "definition_activity" }, { "unique_name": "definition_activity_01JAL4E91F85L5L8jaLVoaHNFnUyVvIxIyB", "name": "Condition Block", "title": "Was the request successful?", "type": "logic.if_else", "base_type": "activity", "properties": { "continue_on_failure": false, "display_name": "Was the request successful?", "skip_execution": false }, "object_type": "definition_activity", "blocks": [ { "unique_name": "definition_activity_01JAL4EGHGO3Y6rtrG5s5MetWzjHs9sCTiF", "name": "Condition Branch", "title": "Success/200", "type": "logic.condition_block", "base_type": "activity", "properties": { "condition": { "left_operand": "$activity.definition_activity_01JAL42HEX0QQ7NMNO7XJ4rC0EveK18kcam.output.status_code$", "operator": "eq", "right_operand": 200 }, "continue_on_failure": false, "display_name": "Success/200", "skip_execution": false }, "object_type": "definition_activity", "actions": [ { "unique_name": "definition_activity_01JAL559K4SRG7CMriE3rokJgS0bddh74Uc", "name": "JSONPath Query", "title": "Extract the token", "type": "corejava.jsonpathquery", "base_type": "activity", "properties": { "action_timeout": 180, "continue_on_failure": true, "display_name": "Extract the token", "input_json": "$activity.definition_activity_01JAL42HEX0QQ7NMNO7XJ4rC0EveK18kcam.output.response_body$", "jsonpath_queries": [ { "jsonpath_query": "$.access_token", "jsonpath_query_name": "token", "jsonpath_query_type": "secure_string" }, { "jsonpath_query": "$.expires_in", "jsonpath_query_name": "expiresIn", "jsonpath_query_type": "integer" } ], "skip_execution": false }, "object_type": "definition_activity" }, { "unique_name": "definition_activity_01JAL7EDNLYD81MpoaYhUUOWL745LCPNTsF", "name": "Condition Block", "title": "Was extraction successful?", "type": "logic.if_else", "base_type": "activity", "properties": { "continue_on_failure": false, "display_name": "Was extraction successful?", "skip_execution": false }, "object_type": "definition_activity", "blocks": [ { "unique_name": "definition_activity_01JAL7ER5SHQG1guygw9pSnvOxQhWvJUVaR", "name": "Condition Branch", "title": "No", "type": "logic.condition_block", "base_type": "activity", "properties": { "condition": { "left_operand": "$activity.definition_activity_01JAL559K4SRG7CMriE3rokJgS0bddh74Uc.output.succeeded$", "operator": "eq", "right_operand": false }, "continue_on_failure": false, "display_name": "No", "skip_execution": false }, "object_type": "definition_activity", "actions": [ { "unique_name": "definition_activity_01JAL7SOS0VT66TyzdMjiTZMDeL2VBwepsU", "name": "Completed", "title": "Failed", "type": "logic.completed", "base_type": "activity", "properties": { "completion_type": "failed-completed", "continue_on_failure": false, "display_name": "Failed", "result_message": "Failed to extract token from response\n\nStatus code: $activity.definition_activity_01JAL42HEX0QQ7NMNO7XJ4rC0EveK18kcam.output.status_code$\nResponse body: $activity.definition_activity_01JAL42HEX0QQ7NMNO7XJ4rC0EveK18kcam.output.response_body$", "skip_execution": false }, "object_type": "definition_activity" } ] } ] }, { "unique_name": "definition_activity_01JAL57G94SG60RStVzr0hXoo9wmeQ5CLV6", "name": "Set Variables", "title": "Set output variables", "type": "core.set_multiple_variables", "base_type": "activity", "properties": { "continue_on_failure": false, "display_name": "Set output variables", "skip_execution": false, "variables_to_update": [ { "variable_to_update": "$workflow.definition_workflow_01JAL22JA2KDM70amrajus8K4adt80jPl6C.output.variable_workflow_01JAL4N53R4SK3xdy9WH4uXGM8tGXCh87xF$", "variable_value_new": "$activity.definition_activity_01JAL559K4SRG7CMriE3rokJgS0bddh74Uc.output.jsonpath_queries.token$" }, { "variable_to_update": "$workflow.definition_workflow_01JAL22JA2KDM70amrajus8K4adt80jPl6C.output.variable_workflow_01JAMJ6TDDRHK7Mn9TpShs327XWNkRihacu$", "variable_value_new": "$activity.definition_activity_01JAL559K4SRG7CMriE3rokJgS0bddh74Uc.output.jsonpath_queries.expiresIn$" } ] }, "object_type": "definition_activity" } ] }, { "unique_name": "definition_activity_01JAL4EHUPKF530yQNvUttEkczKfHkkwdml", "name": "Condition Branch", "title": "Anything else", "type": "logic.condition_block", "base_type": "activity", "properties": { "condition": { "left_operand": "$activity.definition_activity_01JAL42HEX0QQ7NMNO7XJ4rC0EveK18kcam.output.status_code$", "operator": "ne", "right_operand": 200 }, "continue_on_failure": false, "display_name": "Anything else", "skip_execution": false }, "object_type": "definition_activity", "actions": [ { "unique_name": "definition_activity_01JAL58XELI2076Hj5YZ3QgMLb5FxHkSr5B", "name": "Completed", "title": "Failed", "type": "logic.completed", "base_type": "activity", "properties": { "completion_type": "failed-completed", "continue_on_failure": false, "display_name": "Failed", "result_message": "Failed to retrieve access token\n\nStatus code: $activity.definition_activity_01JAL42HEX0QQ7NMNO7XJ4rC0EveK18kcam.output.status_code$\nResponse body: $activity.definition_activity_01JAL42HEX0QQ7NMNO7XJ4rC0EveK18kcam.output.response_body$", "skip_execution": false }, "object_type": "definition_activity" } ] } ] } ], "categories": [ "category_1BMfMXSnJMyt5Ihqi7rWJr5N8cf" ] } }