{"id":13599306,"url":"https://github.com/sysgoblin/PSUmbrella","last_synced_at":"2025-04-10T12:32:06.619Z","repository":{"id":124291640,"uuid":"198657266","full_name":"sysgoblin/PSUmbrella","owner":"sysgoblin","description":"Powershell module for administering Cisco Umbrella.","archived":true,"fork":false,"pushed_at":"2020-02-03T17:29:59.000Z","size":44,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-07T00:41:42.509Z","etag":null,"topics":["api-wrapper","cisco","powershell","umbrella"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sysgoblin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-07-24T14:58:33.000Z","updated_at":"2024-02-15T01:23:37.000Z","dependencies_parsed_at":"2024-01-14T04:44:49.938Z","dependency_job_id":"b7be110f-38d8-45c3-8168-8a51ef48e63d","html_url":"https://github.com/sysgoblin/PSUmbrella","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgoblin%2FPSUmbrella","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgoblin%2FPSUmbrella/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgoblin%2FPSUmbrella/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysgoblin%2FPSUmbrella/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sysgoblin","download_url":"https://codeload.github.com/sysgoblin/PSUmbrella/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248217131,"owners_count":21066633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-wrapper","cisco","powershell","umbrella"],"created_at":"2024-08-01T17:01:02.020Z","updated_at":"2025-04-10T12:32:06.064Z","avatar_url":"https://github.com/sysgoblin.png","language":"PowerShell","funding_links":[],"categories":["PowerShell"],"sub_categories":[],"readme":"# PSUmbrella (wip)\n\nPowershell module for administering Cisco Umbrella.\n\nThis module serves as an api-wrapper for Cisco Umbrella. You need api keys/secrets for the relevant cmdlets.\n\nThey break down as follows:\n\nReporting API\n```powershell\nSearch-Umbrella # Search umbrella activity\n```\n\nManagement API\n```powershell\nGet-UmbrellaNetwork             # List of all networks linked with Umbrella\nGet-UmbrellaRoamingClients      # List of all roaming clients and their status\nGet-UmbrellaSite                # List of sites linked with Umbrella\nGet-UmbrellaVirtualAppliance    # List of all VA's and their status\n```\n\nThere is also an insane amount of data you can interact with from Umbrella which is not accessible via the provided API's. The below cmdlets are made possible by providing a set of log in credentials and are pretty hacky so be warned I accept no responsibility if you use these destructively. These will also likely break if Umbrella change how they provide xsrf tokens or their cookie set up.\nI'm writing up more info on how these work and what kind of data you can interact with.\n\nComplete:\n```powershell\nGet-UmbrellaAccount                 # Get user account info\nGet-UmbrellaApplication             # Get application(s) Umbrella allows you to block/allow\nGet-UmbrellaApplicationSettings     # Get application settings for all or specified app setting policy\nGet-UmbrellaBlockPage               # Get information of configured block pages\nGet-UmbrellaContentCategory         # Returns content category settings. Enabled categories are returned in results for specific content category profile\nGet-UmbrellaDestinationList         # List destination lists or get the destinations of specified destination list\nGet-UmbrellaLinkedMDM               # Get info on MDM solutions linked with Umbrella (note this can include a lot of senstitive info)\nGet-UmbrellaIntegrations            # List integrations with Umbrella including custom ones\nGet-UmbrellaMobileDevice            # Get details of all mobile devices controlled by Umbrella (lots of info!!)\nGet-UmbrellaPolicy                  # Get policy information. Use -Detailed for loads more info\nGet-UmbrellaSecuritySettings        # Umbrella security settings and category selections\n```\n\nWIP:\n```powershell\nGet-UmbrellaActivity                # Get results from activity search\nGet-UmbrellaControlledApplication   # List controlled apps and their status\nSet-UmbrellaAccount                 # Set Umbrella user account information\nSet-UmbrellaBlockPage               # Configure block pages for Umbrella\nSet-UmbrellaDestinationList         # Create, delete and amend destination lists\n```\n\n## Setup\nRun the `Connect-Umbrella` cmdlet to set up the local config file which holds your keys/secrets and org id. These are all exported as SecureStrings and converted back to plaintext when calling a cmdlet.\n```powershell\nConnect-Umbrella -OrgId 1234567 -ReportKey 1234abcdefg -ReportSecret 1234abcdefg -NetworkKey 1234abcdefg -NetworkSecret 1234abcdefg -ManagementKey 1234abcdefg -ManagementSecret 1234abcdefg -Credentials $credsObject\n```\nConfig is stored in `$env:APPDATA\\psumbrella\\umbrellaconfig.json`\n\n## Examples\n```powershell\n# Get the last 5 calls to $domain\nSearch-Umbrella -Domain google.com -Limit 5\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsysgoblin%2FPSUmbrella","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsysgoblin%2FPSUmbrella","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsysgoblin%2FPSUmbrella/lists"}