{ "appid": "f2a239df-acb2-47d6-861c-726a435cfe76", "name": "MS Graph for Active Directory", "description": "Connects to Microsoft Active Directory using MS Graph REST API services to support various generic and investigative actions", "type": "identity management", "product_vendor": "Microsoft", "logo": "logo_msadgraph.svg", "logo_dark": "logo_msadgraph_dark.svg", "product_name": "MS Graph for Active Directory", "product_version_regex": ".*", "publisher": "Splunk", "contributors": [ { "name": "Mathieu A. Cormier" } ], "license": "Copyright (c) 2022-2023 Splunk Inc.", "app_version": "1.4.0", "python_version": "3", "utctime_updated": "2022-04-18T12:59:04.000000Z", "package_name": "phantom_msadgraph", "main_module": "msadgraph_connector.py", "min_phantom_version": "6.1.0", "fips_compliant": true, "latest_tested_versions": [ "Cloud 2023-9-20, API Version: 1.0" ], "app_wizard_version": "1.0.0", "rest_handler": "msadgraph_connector._handle_rest_request", "configuration": { "tenant_id": { "description": "Tenant (Tenant ID or Tenant Name)", "data_type": "string", "required": true, "order": 0 }, "client_id": { "description": "Application ID", "data_type": "string", "required": true, "order": 2 }, "client_secret": { "description": "Client Secret", "data_type": "password", "required": true, "order": 3 }, "region": { "data_type": "string", "description": "Microsoft AD Region", "default": "Global", "order": 1, "value_list": [ "Global", "US Gov L4", "US Gov L5 (DOD)", "Germany", "China (21Vianet)" ] }, "admin_access_required": { "description": "Admin Access Required", "data_type": "boolean", "default": false, "order": 4 }, "admin_access_granted": { "description": "Admin Consent Already Provided", "data_type": "boolean", "default": false, "order": 5 } }, "actions": [ { "action": "test connectivity", "description": "Use supplied credentials to generate a token with MS Graph", "type": "test", "identifier": "test_connectivity", "read_only": true, "parameters": {}, "output": [], "versions": "EQ(*)" }, { "action": "list users", "description": "Get a list of users", "verbose": "For more information on using the filter_string, select_string and expand_string parameters, refer to https://docs.microsoft.com/en-us/graph/query-parameters. By default, only a limited set of properties are returned, to return an alternative property set use $select query parameter.", "type": "investigate", "identifier": "list_users", "read_only": true, "parameters": { "filter_string": { "description": "Filter string to apply to user listing", "data_type": "string", "order": 0 }, "select_string": { "description": "Select string to get additional user properties. Separate multiple values with commas", "data_type": "string", "order": 1 }, "expand_string": { "description": "Expand string to get a resource or collection referenced by a single relationship", "data_type": "string", "order": 2 }, "use_advanced_query": { "description": "Use advanced query capabilities", "data_type": "boolean", "default": false, "order": 3 } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ] }, { "data_path": "action_result.parameter.expand_string", "data_type": "string", "example_values": [ "manager" ] }, { "data_path": "action_result.parameter.filter_string", "data_type": "string", "example_values": [ "startswith(displayName,'User')" ] }, { "data_path": "action_result.parameter.select_string", "data_type": "string", "example_values": [ "displayName" ] }, { "data_path": "action_result.parameter.use_advanced_query", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.accountEnabled", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.ageGroup", "data_type": "string" }, { "data_path": "action_result.data.*.assignedLicenses.*.skuId", "data_type": "string", "example_values": [ "189a915c-fe4f-4ffa-bde4-85b9628d07a0" ] }, { "data_path": "action_result.data.*.assignedPlans.*.assignedTimestamp", "data_type": "string", "example_values": [ "2017-08-29T02:31:40Z" ] }, { "data_path": "action_result.data.*.assignedPlans.*.capabilityStatus", "data_type": "string", "example_values": [ "Enabled" ] }, { "data_path": "action_result.data.*.assignedPlans.*.service", "data_type": "string", "example_values": [ "OfficeForms" ] }, { "data_path": "action_result.data.*.assignedPlans.*.servicePlanId", "data_type": "string", "example_values": [ "e212cbc7-0961-4c40-9825-01117710dcb1" ] }, { "data_path": "action_result.data.*.city", "data_type": "string", "example_values": [ "Palo Alto" ] }, { "data_path": "action_result.data.*.companyName", "data_type": "string" }, { "data_path": "action_result.data.*.consentProvidedForMinor", "data_type": "string" }, { "data_path": "action_result.data.*.country", "data_type": "string", "example_values": [ "US" ] }, { "data_path": "action_result.data.*.createdDateTime", "data_type": "string", "example_values": [ "2019-05-21T22:27:20Z" ] }, { "data_path": "action_result.data.*.creationType", "data_type": "string" }, { "data_path": "action_result.data.*.deletionTimestamp", "data_type": "string" }, { "data_path": "action_result.data.*.department", "data_type": "string", "example_values": [ "Sales" ] }, { "data_path": "action_result.data.*.dirSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.displayName", "data_type": "string", "column_name": "Display Name", "column_order": 0, "example_values": [ "User" ] }, { "data_path": "action_result.data.*.employeeId", "data_type": "string" }, { "data_path": "action_result.data.*.facsimileTelephoneNumber", "data_type": "string" }, { "data_path": "action_result.data.*.givenName", "data_type": "string", "example_values": [ "testuser" ] }, { "data_path": "action_result.data.*.id", "data_type": "string", "column_name": "Object ID", "column_order": 1, "example_values": [ "e4c722ac-3b83-478d-8f52-c388885dc30f" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.immutableId", "data_type": "string" }, { "data_path": "action_result.data.*.isCompromised", "data_type": "string" }, { "data_path": "action_result.data.*.jobTitle", "data_type": "string", "example_values": [ "Sales Manager" ] }, { "data_path": "action_result.data.*.lastDirSyncTime", "data_type": "string" }, { "data_path": "action_result.data.*.legalAgeGroupClassification", "data_type": "string" }, { "data_path": "action_result.data.*.mail", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "email" ] }, { "data_path": "action_result.data.*.mailNickname", "data_type": "string", "example_values": [ "testmail" ] }, { "data_path": "action_result.data.*.mobile", "data_type": "string", "example_values": [ "+1 5556378688" ] }, { "data_path": "action_result.data.*.mobilePhone", "data_type": "string" }, { "data_path": "action_result.data.*.objectType", "data_type": "string", "example_values": [ "User" ] }, { "data_path": "action_result.data.*.odata.type", "data_type": "string", "example_values": [ "test.DirectoryServices.User" ] }, { "data_path": "action_result.data.*.officeLocation", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesDistinguishedName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSecurityIdentifier", "data_type": "string" }, { "data_path": "action_result.data.*.otherMails", "data_type": "string", "example_values": [ "user.test@outlook.com" ], "contains": [ "email" ] }, { "data_path": "action_result.data.*.passwordPolicies", "data_type": "string", "example_values": [ "None" ] }, { "data_path": "action_result.data.*.passwordProfile", "data_type": "string" }, { "data_path": "action_result.data.*.passwordProfile.enforceChangePasswordPolicy", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.passwordProfile.forceChangePasswordNextLogin", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.passwordProfile.password", "data_type": "string" }, { "data_path": "action_result.data.*.physicalDeliveryOfficeName", "data_type": "string" }, { "data_path": "action_result.data.*.postalCode", "data_type": "string", "example_values": [ "94303" ] }, { "data_path": "action_result.data.*.preferredLanguage", "data_type": "string", "example_values": [ "en-US" ] }, { "data_path": "action_result.data.*.provisionedPlans.*.capabilityStatus", "data_type": "string", "example_values": [ "Enabled" ] }, { "data_path": "action_result.data.*.provisionedPlans.*.provisioningStatus", "data_type": "string", "example_values": [ "Success" ] }, { "data_path": "action_result.data.*.provisionedPlans.*.service", "data_type": "string", "example_values": [ "exchange" ] }, { "data_path": "action_result.data.*.proxyAddresses", "data_type": "string", "example_values": [ "SMTP:user1@test.com" ] }, { "data_path": "action_result.data.*.refreshTokensValidFromDateTime", "data_type": "string", "example_values": [ "2017-09-27T22:54:59Z" ] }, { "data_path": "action_result.data.*.showInAddressList", "data_type": "string" }, { "data_path": "action_result.data.*.sipProxyAddress", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "email" ] }, { "data_path": "action_result.data.*.state", "data_type": "string", "example_values": [ "CA" ] }, { "data_path": "action_result.data.*.streetAddress", "data_type": "string", "example_values": [ "2479 E. Bayshore Rd." ] }, { "data_path": "action_result.data.*.surname", "data_type": "string", "example_values": [ "Test_surname" ] }, { "data_path": "action_result.data.*.telephoneNumber", "data_type": "string" }, { "data_path": "action_result.data.*.thumbnailPhoto@odata.mediaEditLink", "data_type": "string", "example_values": [ "directoryObjects/6132ca31-7a09-434f-a269-abe836d0c01e/test.DirectoryServices.User/thumbnailPhoto" ] }, { "data_path": "action_result.data.*.usageLocation", "data_type": "string", "example_values": [ "US" ] }, { "data_path": "action_result.data.*.userPrincipalName", "data_type": "string", "column_name": "User Principal Name", "column_order": 2, "example_values": [ "user@test.com" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.userState", "data_type": "string" }, { "data_path": "action_result.data.*.userStateChangedOn", "data_type": "string" }, { "data_path": "action_result.data.*.userType", "data_type": "string", "example_values": [ "Member" ] }, { "data_path": "action_result.summary.num_users", "data_type": "numeric", "example_values": [ 8 ] }, { "data_path": "action_result.summary.result_found", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.summary.total_results", "data_type": "numeric", "example_values": [ 7 ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Successfully listed users" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "custom", "title": "List Users", "view": "msadgraph_view.display_view" }, "versions": "EQ(*)" }, { "action": "reset password", "description": "Reset or set a user's password in a Microsoft AD environment", "type": "contain", "identifier": "reset_password", "read_only": false, "parameters": { "user_id": { "description": "User ID to change password - can be user principal name or object ID", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "user id" ] }, "force_change": { "description": "Force user to change password on next login", "data_type": "boolean", "default": true, "order": 1 }, "temp_password": { "description": "Temporary password for user", "data_type": "string", "required": true, "order": 2 } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 1 }, { "data_path": "action_result.parameter.force_change", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.parameter.temp_password", "data_type": "string", "example_values": [ "Temp_PA$$w0rd" ] }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "ee3dc4f2-70f9-446f-a19e-6b4e95ba030d", "user@test.com" ], "contains": [ "user id" ], "column_name": "User ID", "column_order": 0 }, { "data_path": "action_result.data", "data_type": "string" }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully reset user password" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Status: Successfully reset user password" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "width": 12, "title": "User Password Reset", "type": "table", "height": 5 }, "versions": "EQ(*)" }, { "action": "disable tokens", "description": "Invalidate all active refresh tokens for a user in a Microsoft AD environment", "type": "contain", "identifier": "invalidate_tokens", "read_only": false, "parameters": { "user_id": { "description": "User ID to disable tokens of - can be user principal name or object ID", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "user id" ] } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 1 }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "ee3dc4f2-70f9-446f-a19e-6b4e95ba030d", "user@test.com" ], "contains": [ "user id" ], "column_name": "User ID", "column_order": 0 }, { "data_path": "action_result.data", "data_type": "string" }, { "data_path": "action_result.data.*.@odata.context", "data_type": "string", "example_values": [ "https://graph.test.com/v1.0/$metadata#Edm.Boolean" ] }, { "data_path": "action_result.data.*.odata.metadata", "data_type": "string", "example_values": [ "https://graph.windows.net/1t309est-db6c-4tes-t1d2-12bf3456d78d/$metadata#Edm.Null" ], "contains": [ "url" ] }, { "data_path": "action_result.data.*.odata.null", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.value", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully disabled tokens" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Successfully invalidated tokens", "Status: Successfully disabled tokens" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "width": 12, "title": "Invalidate Tokens", "type": "table", "height": 5 }, "versions": "EQ(*)" }, { "action": "enable user", "description": "Enable a user", "type": "generic", "identifier": "enable_user", "read_only": false, "undo": "disable user", "parameters": { "user_id": { "description": "User ID to enable - can be user principal name or object ID", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "user id" ] } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 1 }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "user id" ], "column_name": "User ID", "column_order": 0 }, { "data_path": "action_result.data", "data_type": "string" }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully enabled user user@test.com" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Status: Successfully enabled user user@test.com" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "table" }, "versions": "EQ(*)" }, { "action": "disable user", "description": "Disable a user", "type": "generic", "identifier": "disable_user", "read_only": false, "undo": "enable user", "parameters": { "user_id": { "description": "User ID to disable - can be user principal name or object ID", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "user id" ] } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 1 }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "user id" ], "column_name": "User ID", "column_order": 0 }, { "data_path": "action_result.data", "data_type": "string" }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully disabled user user@test.com" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Status: Successfully disabled user user@test.com" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "table" }, "versions": "EQ(*)" }, { "action": "list user devices", "description": "List devices for a specified user", "verbose": "By default, only a limited set of properties are returned, to return an alternative property set use $select query parameter. For more information on using the select_string parameter, refer to this documentation.", "type": "investigate", "identifier": "list_user_devices", "read_only": true, "parameters": { "user_id": { "description": "User ID - can be user principal name or object ID", "data_type": "string", "primary": true, "required": true, "order": 0, "contains": [ "user id" ] }, "select_string": { "description": "Select string to get additional user properties. Separate multiple values with commas", "data_type": "string", "order": 1 } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ] }, { "data_path": "action_result.parameter.select_string", "data_type": "string", "example_values": [ "displayName" ] }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.@odata.type", "data_type": "string", "example_values": [ "#test.graph.device" ] }, { "data_path": "action_result.data.*.accountEnabled", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.alternativeSecurityIds.*.identityProvider", "data_type": "string" }, { "data_path": "action_result.data.*.alternativeSecurityIds.*.key", "data_type": "string", "example_values": [ "WAA1ADAAOQA6ADwAUwBIAEEAMQAtAFQAUAAtAFAAVQBCAEsARQBZAD4AOQA5AEEARQAwADgAOABDAEUANAA1ADgAMABCADcAQgBGAEEARQA2ADEAQQBCADYANAA3ADYANgA5ADUAOAAzAEQANABFAEYARQA5ADYAOAAyAHkAcQBSAEIANwBrAGEAMQA4AEoATAByACsAegB4AE8AYwB6AE8AYgBNAFEANQBZAEgAbgB0AFQAdgBOAG0AbgA5AEQAZQA2AFgAVQBUAGgAcwBFAD0A" ] }, { "data_path": "action_result.data.*.alternativeSecurityIds.*.type", "data_type": "numeric", "example_values": [ 2 ] }, { "data_path": "action_result.data.*.approximateLastSignInDateTime", "data_type": "string", "example_values": [ "2019-09-26T03:42:15Z" ] }, { "data_path": "action_result.data.*.complianceExpirationDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.createdDateTime", "data_type": "string", "example_values": [ "2019-09-26T03:42:15Z" ] }, { "data_path": "action_result.data.*.deletedDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.deviceCategory", "data_type": "string" }, { "data_path": "action_result.data.*.deviceId", "data_type": "string" }, { "data_path": "action_result.data.*.deviceMetadata", "data_type": "string" }, { "data_path": "action_result.data.*.deviceOwnership", "data_type": "string" }, { "data_path": "action_result.data.*.deviceVersion", "data_type": "numeric" }, { "data_path": "action_result.data.*.displayName", "data_type": "string" }, { "data_path": "action_result.data.*.domainName", "data_type": "string" }, { "data_path": "action_result.data.*.enrollmentProfileName", "data_type": "string" }, { "data_path": "action_result.data.*.enrollmentType", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute1", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute10", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute11", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute12", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute13", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute14", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute15", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute2", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute3", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute4", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute5", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute6", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute7", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute8", "data_type": "string" }, { "data_path": "action_result.data.*.extensionAttributes.extensionAttribute9", "data_type": "string" }, { "data_path": "action_result.data.*.externalSourceName", "data_type": "string" }, { "data_path": "action_result.data.*.id", "data_type": "string" }, { "data_path": "action_result.data.*.isCompliant", "data_type": "boolean" }, { "data_path": "action_result.data.*.isManaged", "data_type": "boolean" }, { "data_path": "action_result.data.*.isRooted", "data_type": "string" }, { "data_path": "action_result.data.*.managementType", "data_type": "string" }, { "data_path": "action_result.data.*.manufacturer", "data_type": "string" }, { "data_path": "action_result.data.*.mdmAppId", "data_type": "string" }, { "data_path": "action_result.data.*.model", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesLastSyncDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSyncEnabled", "data_type": "boolean" }, { "data_path": "action_result.data.*.operatingSystem", "data_type": "string", "example_values": [ "Windows" ] }, { "data_path": "action_result.data.*.operatingSystemVersion", "data_type": "string", "example_values": [ "10.0.18362.0" ] }, { "data_path": "action_result.data.*.profileType", "data_type": "string", "example_values": [ "RegisteredDevice" ] }, { "data_path": "action_result.data.*.registrationDateTime", "data_type": "string", "example_values": [ "2019-09-26T03:42:15Z" ] }, { "data_path": "action_result.data.*.sourceType", "data_type": "string" }, { "data_path": "action_result.data.*.trustType", "data_type": "string", "example_values": [ "Workplace" ] }, { "data_path": "action_result.summary", "data_type": "string" }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully retrieved owned devices for user test@user.test.com" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Status: Successfully retrieved owned devices for user test@user.test.com" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "custom", "title": "Owned Devices", "view": "msadgraph_view.display_view" }, "versions": "EQ(*)" }, { "action": "list user attributes", "description": "List attributes for all or a specified user", "verbose": "By default, only a limited set of properties are returned, to return an alternative property set use $select query parameter. For more information on using the select_string and expand_string parameters, refer to https://docs.microsoft.com/en-us/graph/query-parameters.", "type": "investigate", "identifier": "list_user_attributes", "read_only": true, "parameters": { "user_id": { "description": "User ID - can be user principal name or object ID", "data_type": "string", "primary": true, "order": 0, "contains": [ "user id" ] }, "select_string": { "description": "Select string to get additional user properties. Separate multiple values with commas", "data_type": "string", "order": 1 }, "expand_string": { "description": "Expand string to get a resource or collection referenced by a single relationship", "data_type": "string", "order": 2 }, "use_advanced_query": { "description": "Use advanced query capabilities", "data_type": "boolean", "default": false, "order": 3 } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ] }, { "data_path": "action_result.parameter.expand_string", "data_type": "string", "example_values": [ "manager" ] }, { "data_path": "action_result.parameter.select_string", "data_type": "string", "example_values": [ "displayName" ] }, { "data_path": "action_result.parameter.use_advanced_query", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.@odata.context", "data_type": "string", "example_values": [ "https://graph.test.com/v1.0/$metadata#users/$entity" ] }, { "data_path": "action_result.data.*.accountEnabled", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.ageGroup", "data_type": "string" }, { "data_path": "action_result.data.*.assignedLicenses.*.skuId", "data_type": "string", "example_values": [ "f30db892-07e9-47e9-837c-80727f46fd3d" ] }, { "data_path": "action_result.data.*.assignedPlans.*.assignedTimestamp", "data_type": "string", "example_values": [ "2019-04-26T07:21:18Z" ] }, { "data_path": "action_result.data.*.assignedPlans.*.capabilityStatus", "data_type": "string", "example_values": [ "Enabled" ] }, { "data_path": "action_result.data.*.assignedPlans.*.service", "data_type": "string", "example_values": [ "exchange" ] }, { "data_path": "action_result.data.*.assignedPlans.*.servicePlanId", "data_type": "string", "example_values": [ "33c4f319-9bdd-48d6-9c4d-410b750a4a5a" ] }, { "data_path": "action_result.data.*.city", "data_type": "string" }, { "data_path": "action_result.data.*.companyName", "data_type": "string" }, { "data_path": "action_result.data.*.consentProvidedForMinor", "data_type": "string" }, { "data_path": "action_result.data.*.country", "data_type": "string" }, { "data_path": "action_result.data.*.createdDateTime", "data_type": "string", "example_values": [ "2019-05-02T20:27:59Z" ] }, { "data_path": "action_result.data.*.creationType", "data_type": "string" }, { "data_path": "action_result.data.*.deletionTimestamp", "data_type": "string" }, { "data_path": "action_result.data.*.department", "data_type": "string", "example_values": [ "Sales" ] }, { "data_path": "action_result.data.*.dirSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.displayName", "data_type": "string", "example_values": [ "Test User" ] }, { "data_path": "action_result.data.*.employeeId", "data_type": "string" }, { "data_path": "action_result.data.*.facsimileTelephoneNumber", "data_type": "string" }, { "data_path": "action_result.data.*.givenName", "data_type": "string" }, { "data_path": "action_result.data.*.id", "data_type": "string", "example_values": [ "7d55d7e6-cf5a-4dd2-a176-57a3c33b7fa9" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.identities.*.issuer", "data_type": "string", "example_values": [ "test.com" ] }, { "data_path": "action_result.data.*.identities.*.issuerAssignedId", "data_type": "string", "example_values": [ "test2@user.test.com" ] }, { "data_path": "action_result.data.*.identities.*.signInType", "data_type": "string", "example_values": [ "userPrincipalName" ] }, { "data_path": "action_result.data.*.immutableId", "data_type": "string" }, { "data_path": "action_result.data.*.isCompromised", "data_type": "string" }, { "data_path": "action_result.data.*.jobTitle", "data_type": "string" }, { "data_path": "action_result.data.*.lastDirSyncTime", "data_type": "string" }, { "data_path": "action_result.data.*.legalAgeGroupClassification", "data_type": "string" }, { "data_path": "action_result.data.*.mail", "data_type": "string", "contains": [ "email" ] }, { "data_path": "action_result.data.*.mailNickname", "data_type": "string", "example_values": [ "test" ] }, { "data_path": "action_result.data.*.mobile", "data_type": "string" }, { "data_path": "action_result.data.*.mobilePhone", "data_type": "string" }, { "data_path": "action_result.data.*.objectId", "data_type": "string", "example_values": [ "59f51194-1998-4932-a8ac-468e59374edc" ] }, { "data_path": "action_result.data.*.objectType", "data_type": "string", "example_values": [ "User" ] }, { "data_path": "action_result.data.*.odata.metadata", "data_type": "string", "example_values": [ "https://graph.windows.net/1t309est-db6c-4tes-t1d2-12bf3456d78d/$metadata#directoryObjects/@Element" ] }, { "data_path": "action_result.data.*.odata.type", "data_type": "string", "example_values": [ "test.DirectoryServices.User" ] }, { "data_path": "action_result.data.*.officeLocation", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesDistinguishedName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSecurityIdentifier", "data_type": "string" }, { "data_path": "action_result.data.*.otherMails", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "email" ] }, { "data_path": "action_result.data.*.passwordPolicies", "data_type": "string" }, { "data_path": "action_result.data.*.passwordProfile", "data_type": "string" }, { "data_path": "action_result.data.*.passwordProfile.enforceChangePasswordPolicy", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.passwordProfile.forceChangePasswordNextLogin", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.passwordProfile.password", "data_type": "string" }, { "data_path": "action_result.data.*.physicalDeliveryOfficeName", "data_type": "string" }, { "data_path": "action_result.data.*.postalCode", "data_type": "string" }, { "data_path": "action_result.data.*.preferredLanguage", "data_type": "string" }, { "data_path": "action_result.data.*.provisionedPlans.*.capabilityStatus", "data_type": "string", "example_values": [ "Enabled" ] }, { "data_path": "action_result.data.*.provisionedPlans.*.provisioningStatus", "data_type": "string", "example_values": [ "Success" ] }, { "data_path": "action_result.data.*.provisionedPlans.*.service", "data_type": "string", "example_values": [ "exchange" ] }, { "data_path": "action_result.data.*.proxyAddresses", "data_type": "string", "example_values": [ "SMTP:test_shared_mailbox@test.com" ] }, { "data_path": "action_result.data.*.refreshTokensValidFromDateTime", "data_type": "string", "example_values": [ "2019-05-16T19:54:18Z" ] }, { "data_path": "action_result.data.*.showInAddressList", "data_type": "string" }, { "data_path": "action_result.data.*.sipProxyAddress", "data_type": "string", "contains": [ "email" ] }, { "data_path": "action_result.data.*.state", "data_type": "string" }, { "data_path": "action_result.data.*.streetAddress", "data_type": "string" }, { "data_path": "action_result.data.*.surname", "data_type": "string" }, { "data_path": "action_result.data.*.telephoneNumber", "data_type": "string" }, { "data_path": "action_result.data.*.thumbnailPhoto@odata.mediaEditLink", "data_type": "string", "example_values": [ "directoryObjects/59f12345-1998-4932-a8ac-468e59374edc/test.DirectoryServices.User/thumbnailPhoto" ] }, { "data_path": "action_result.data.*.usageLocation", "data_type": "string", "example_values": [ "US" ] }, { "data_path": "action_result.data.*.userPrincipalName", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.userState", "data_type": "string" }, { "data_path": "action_result.data.*.userStateChangedOn", "data_type": "string" }, { "data_path": "action_result.data.*.userType", "data_type": "string", "example_values": [ "Member" ] }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully retrieved user attributes", "Successfully retrieved attributes for user user@test.com" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Status: Successfully retrieved user attributes", "Status: Successfully retrieved attributes for user user@test.com, User enabled: False" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "custom", "title": "list user attributes", "view": "msadgraph_view.display_view" }, "versions": "EQ(*)" }, { "action": "set user attribute", "description": "Set an attribute for a user", "type": "generic", "identifier": "set_user_attribute", "read_only": false, "parameters": { "user_id": { "description": "User ID - can be user principal name or object ID", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "user id" ] }, "ph_0": { "description": "Placeholder", "data_type": "ph", "order": 1 }, "attribute": { "description": "Attribute to set", "data_type": "string", "required": true, "order": 2 }, "attribute_value": { "description": "Value of attribute to set", "data_type": "string", "required": true, "order": 3 } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 3 }, { "data_path": "action_result.parameter.attribute", "data_type": "string", "example_values": [ "department" ], "column_name": "Attribute Name", "column_order": 1 }, { "data_path": "action_result.parameter.attribute_value", "data_type": "string", "example_values": [ "Sales" ], "column_name": "Attribute Value", "column_order": 2 }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "user id" ], "column_name": "User ID", "column_order": 0 }, { "data_path": "action_result.data", "data_type": "string" }, { "data_path": "action_result.data.*.classification", "data_type": "string" }, { "data_path": "action_result.data.*.createdDateTime", "data_type": "string", "example_values": [ "2021-03-25T18:40:53Z" ] }, { "data_path": "action_result.data.*.deletedDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.deletionTimestamp", "data_type": "string" }, { "data_path": "action_result.data.*.description", "data_type": "string", "example_values": [ "This is for testing purpose" ] }, { "data_path": "action_result.data.*.dirSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.displayName", "data_type": "string", "example_values": [ "Test-site" ] }, { "data_path": "action_result.data.*.expirationDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.id", "data_type": "string", "example_values": [ "2a201c95-101b-42d9-a7af-9a2fdf8193f1" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.isAssignableToRole", "data_type": "string" }, { "data_path": "action_result.data.*.lastDirSyncTime", "data_type": "string" }, { "data_path": "action_result.data.*.mail", "data_type": "string", "example_values": [ "Test-site@test.com" ], "contains": [ "email" ] }, { "data_path": "action_result.data.*.mailEnabled", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.mailNickname", "data_type": "string", "example_values": [ "Test-site" ] }, { "data_path": "action_result.data.*.membershipRule", "data_type": "string" }, { "data_path": "action_result.data.*.membershipRuleProcessingState", "data_type": "string" }, { "data_path": "action_result.data.*.objectType", "data_type": "string", "example_values": [ "Group" ] }, { "data_path": "action_result.data.*.odata.type", "data_type": "string", "example_values": [ "test.DirectoryServices.Group" ] }, { "data_path": "action_result.data.*.onPremisesDomainName", "data_type": "string", "contains": [ "domain" ] }, { "data_path": "action_result.data.*.onPremisesLastSyncDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesNetBiosName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSamAccountName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSecurityIdentifier", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.preferredDataLocation", "data_type": "string" }, { "data_path": "action_result.data.*.preferredLanguage", "data_type": "string" }, { "data_path": "action_result.data.*.proxyAddresses", "data_type": "string", "example_values": [ "SMTP:test-h@test.com" ] }, { "data_path": "action_result.data.*.renewedDateTime", "data_type": "string", "example_values": [ "2021-03-25T18:40:53Z" ] }, { "data_path": "action_result.data.*.securityEnabled", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.securityIdentifier", "data_type": "string", "example_values": [ "S-1-12-1-294681889-1319597617-672379543-28952017" ] }, { "data_path": "action_result.data.*.theme", "data_type": "string" }, { "data_path": "action_result.data.*.visibility", "data_type": "string", "example_values": [ "Private" ] }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully enabled user user@test.com" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Status: Successfully enabled user user@test.com" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "table" }, "versions": "EQ(*)" }, { "action": "remove user", "description": "Remove a user from a specified group", "type": "generic", "identifier": "remove_user", "read_only": false, "undo": "add user", "parameters": { "group_object_id": { "description": "Object ID of group", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "group object id" ] }, "user_id": { "description": "User ID to remove from group", "data_type": "string", "required": true, "primary": true, "order": 1, "contains": [ "user id" ] } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 2 }, { "data_path": "action_result.parameter.group_object_id", "data_type": "string", "example_values": [ "ddb876b3-603a-437b-9814-2d46a2219a1e" ], "contains": [ "group object id" ], "column_name": "Group Object ID", "column_order": 0 }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "17be76d0-35ed-4881-ab62-d2eb73c2ebe3" ], "contains": [ "user id" ], "column_name": "User ID", "column_order": 1 }, { "data_path": "action_result.data", "data_type": "string" }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully removed user from group", "User not in group" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Status: Successfully removed user from group", "Status: User not in group" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "table" }, "versions": "EQ(*)" }, { "action": "add user", "description": "Add a user to a specified group", "type": "generic", "identifier": "add_user", "read_only": false, "undo": "remove user", "parameters": { "group_object_id": { "description": "Object ID of group", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "group object id" ] }, "user_id": { "description": "User ID to add to group", "data_type": "string", "required": true, "primary": true, "order": 1, "contains": [ "user id" ] } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 2 }, { "data_path": "action_result.parameter.group_object_id", "data_type": "string", "example_values": [ "ddb876b3-603a-437b-9814-2d46a2219a1e" ], "contains": [ "group object id" ], "column_name": "Group Object ID", "column_order": 0 }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "17be76d0-35ed-4881-ab62-d2eb73c2ebe3" ], "contains": [ "user id" ], "column_name": "User ID", "column_order": 1 }, { "data_path": "action_result.data", "data_type": "string" }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully added user to group", "User already in group" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Status: Successfully added user to group", "Status: User already in group" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "table" }, "versions": "EQ(*)" }, { "action": "list groups", "description": "List groups in the organization", "verbose": "By default, only a limited set of properties are returned, to return an alternative property set use $select query parameter. For more information on using the select_string and expand_string parameters, refer to https://docs.microsoft.com/en-us/graph/query-parameters.", "type": "investigate", "identifier": "list_groups", "read_only": true, "parameters": { "filter_string": { "description": "Filter string to apply to group listing", "data_type": "string", "order": 0 }, "select_string": { "description": "Select string to get additional group properties. Separate multiple values with commas", "data_type": "string", "order": 1 }, "expand_string": { "description": "Expand string to get a resource or collection referenced by a single relationship", "data_type": "string", "order": 2 }, "use_advanced_query": { "description": "Use advanced query capabilities", "data_type": "boolean", "default": false, "order": 3 } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ] }, { "data_path": "action_result.parameter.expand_string", "data_type": "string", "example_values": [ "members" ] }, { "data_path": "action_result.parameter.filter_string", "data_type": "string", "example_values": [ "createdDateTime ge '2014-01-01T00:00:00Z'" ] }, { "data_path": "action_result.parameter.select_string", "data_type": "string", "example_values": [ "displayName" ] }, { "data_path": "action_result.parameter.use_advanced_query", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.classification", "data_type": "string" }, { "data_path": "action_result.data.*.createdDateTime", "data_type": "string", "example_values": [ "2021-03-25T18:40:53Z" ] }, { "data_path": "action_result.data.*.deletedDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.deletionTimestamp", "data_type": "string" }, { "data_path": "action_result.data.*.description", "data_type": "string", "example_values": [ "This is for testing purpose" ], "column_name": "Description", "column_order": 1 }, { "data_path": "action_result.data.*.dirSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.displayName", "data_type": "string", "example_values": [ "Test-site" ], "column_name": "Display Name", "column_order": 0 }, { "data_path": "action_result.data.*.expirationDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.id", "data_type": "string", "example_values": [ "2a201c95-101b-42d9-a7af-9a2fdf8193f1" ], "contains": [ "group object id" ] }, { "data_path": "action_result.data.*.isAssignableToRole", "data_type": "string" }, { "data_path": "action_result.data.*.lastDirSyncTime", "data_type": "string" }, { "data_path": "action_result.data.*.mail", "data_type": "string", "example_values": [ "Test-site@test.com" ], "contains": [ "email" ] }, { "data_path": "action_result.data.*.mailEnabled", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.mailNickname", "data_type": "string", "example_values": [ "Test-site" ] }, { "data_path": "action_result.data.*.membershipRule", "data_type": "string" }, { "data_path": "action_result.data.*.membershipRuleProcessingState", "data_type": "string" }, { "data_path": "action_result.data.*.objectType", "data_type": "string", "example_values": [ "Group" ] }, { "data_path": "action_result.data.*.odata.type", "data_type": "string", "example_values": [ "test.DirectoryServices.Group" ] }, { "data_path": "action_result.data.*.onPremisesDomainName", "data_type": "string", "contains": [ "domain" ] }, { "data_path": "action_result.data.*.onPremisesLastSyncDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesNetBiosName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSamAccountName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSecurityIdentifier", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.preferredDataLocation", "data_type": "string" }, { "data_path": "action_result.data.*.preferredLanguage", "data_type": "string" }, { "data_path": "action_result.data.*.proxyAddresses", "data_type": "string", "example_values": [ "SMTP:test-h@test.com" ] }, { "data_path": "action_result.data.*.renewedDateTime", "data_type": "string", "example_values": [ "2021-03-25T18:40:53Z" ] }, { "data_path": "action_result.data.*.securityEnabled", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.securityIdentifier", "data_type": "string", "example_values": [ "S-1-12-1-294681889-1319597617-672379543-28952017" ] }, { "data_path": "action_result.data.*.theme", "data_type": "string" }, { "data_path": "action_result.data.*.visibility", "data_type": "string", "example_values": [ "Private" ] }, { "data_path": "action_result.summary.num_groups", "data_type": "numeric", "example_values": [ 7 ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Num groups: 7" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "custom", "title": "List Groups", "view": "msadgraph_view.display_view" }, "versions": "EQ(*)" }, { "action": "get group", "description": "Get information about a group", "verbose": "By default, only a limited set of properties are returned, to return an alternative property set use $select query parameter. For more information on using the select_string and expand_string parameters, refer to https://docs.microsoft.com/en-us/graph/query-parameters.", "type": "investigate", "identifier": "get_group", "read_only": true, "parameters": { "object_id": { "description": "Object ID of group", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "group object id" ] }, "select_string": { "description": "Select string to get additional group properties. Separate multiple values with commas", "data_type": "string", "order": 1 }, "expand_string": { "description": "Expand string to get a resource or collection referenced by a single relationship", "data_type": "string", "order": 2 }, "use_advanced_query": { "description": "Use advanced query capabilities", "data_type": "boolean", "default": false, "order": 3 } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ] }, { "data_path": "action_result.parameter.expand_string", "data_type": "string", "example_values": [ "members" ] }, { "data_path": "action_result.parameter.object_id", "data_type": "string", "example_values": [ "ddb876b3-603a-437b-9814-2d46a2219a1e" ], "contains": [ "group object id" ] }, { "data_path": "action_result.parameter.select_string", "data_type": "string", "example_values": [ "displayName" ] }, { "data_path": "action_result.parameter.use_advanced_query", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.@odata.context", "data_type": "string", "example_values": [ "https://graph.test.com/v1.0/$metadata#groups(id,displayName)/$entity" ] }, { "data_path": "action_result.data.*.classification", "data_type": "string" }, { "data_path": "action_result.data.*.createdDateTime", "data_type": "string", "example_values": [ "2020-08-05T11:59:49Z" ] }, { "data_path": "action_result.data.*.deletedDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.deletionTimestamp", "data_type": "string" }, { "data_path": "action_result.data.*.description", "data_type": "string", "example_values": [ "This is the office 365 group" ] }, { "data_path": "action_result.data.*.dirSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.displayName", "data_type": "string", "example_values": [ "o365group" ], "column_name": "Display Name", "column_order": 0 }, { "data_path": "action_result.data.*.expirationDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.id", "data_type": "string", "example_values": [ "ddb876b3-603a-437b-9814-2d46a2219a1e" ], "contains": [ "group object id" ], "column_name": "Object ID", "column_order": 1 }, { "data_path": "action_result.data.*.isAssignableToRole", "data_type": "string" }, { "data_path": "action_result.data.*.lastDirSyncTime", "data_type": "string" }, { "data_path": "action_result.data.*.mail", "data_type": "string", "example_values": [ "bc7f9cabe@test.com" ], "contains": [ "email" ] }, { "data_path": "action_result.data.*.mailEnabled", "data_type": "boolean", "example_values": [ true, false ], "column_name": "Mail Enabled", "column_order": 3 }, { "data_path": "action_result.data.*.mailNickname", "data_type": "string", "example_values": [ "bc7f9cabe" ] }, { "data_path": "action_result.data.*.membershipRule", "data_type": "string" }, { "data_path": "action_result.data.*.membershipRuleProcessingState", "data_type": "string" }, { "data_path": "action_result.data.*.objectType", "data_type": "string", "example_values": [ "Group" ] }, { "data_path": "action_result.data.*.odata.metadata", "data_type": "string", "example_values": [ "https://graph.windows.net/1t309est-db6c-4tes-t1d2-12bf3456d78d/$metadata#directoryObjects/@Element" ] }, { "data_path": "action_result.data.*.odata.type", "data_type": "string", "example_values": [ "test.DirectoryServices.Group" ] }, { "data_path": "action_result.data.*.onPremisesDomainName", "data_type": "string", "contains": [ "domain" ] }, { "data_path": "action_result.data.*.onPremisesLastSyncDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesNetBiosName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSamAccountName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSecurityIdentifier", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.preferredDataLocation", "data_type": "string" }, { "data_path": "action_result.data.*.preferredLanguage", "data_type": "string" }, { "data_path": "action_result.data.*.proxyAddresses", "data_type": "string", "example_values": [ "SMTP:bc7f9cabe@test.com" ] }, { "data_path": "action_result.data.*.renewedDateTime", "data_type": "string", "example_values": [ "2020-08-05T11:59:49Z" ] }, { "data_path": "action_result.data.*.securityEnabled", "data_type": "boolean", "example_values": [ true, false ], "column_name": "Security Enabled", "column_order": 2 }, { "data_path": "action_result.data.*.securityIdentifier", "data_type": "string", "example_values": [ "S-1-12-1-909260723-1083662375-1952945031-2402852259" ] }, { "data_path": "action_result.data.*.theme", "data_type": "string" }, { "data_path": "action_result.data.*.visibility", "data_type": "string" }, { "data_path": "action_result.summary.display_name", "data_type": "string", "example_values": [ "o365group" ] }, { "data_path": "action_result.summary.status", "data_type": "string", "example_values": [ "Successfully retrieved group 104d4576-1544-48b5-bb7e-9f8f871aa824" ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Display name: o365group" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "custom", "title": "List Groups", "view": "msadgraph_view.display_view" }, "versions": "EQ(*)" }, { "action": "list group members", "description": "List the members in a group", "verbose": "By default, only a limited set of properties are returned, to return an alternative property set use $select query parameter. For more information on using the select_string and expand_string parameters, refer to https://docs.microsoft.com/en-us/graph/query-parameters.", "type": "investigate", "identifier": "list_group_members", "read_only": true, "parameters": { "group_object_id": { "description": "Object ID of group", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "group object id" ] }, "select_string": { "description": "Select string to get additional properties. Separate multiple values with commas", "data_type": "string", "order": 1 }, "expand_string": { "description": "Expand string to get a resource or collection referenced by a single relationship", "data_type": "string", "order": 2 }, "use_advanced_query": { "description": "Use advanced query capabilities", "data_type": "boolean", "default": false, "order": 3 } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ] }, { "data_path": "action_result.parameter.expand_string", "data_type": "string", "example_values": [ "manager" ] }, { "data_path": "action_result.parameter.group_object_id", "data_type": "string", "example_values": [ "ebcd3130-55a1-4cbf-81b2-86408ff21203" ], "contains": [ "group object id" ] }, { "data_path": "action_result.parameter.select_string", "data_type": "string", "example_values": [ "displayName" ] }, { "data_path": "action_result.parameter.use_advanced_query", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.@odata.type", "data_type": "string", "example_values": [ "#test.graph.user" ] }, { "data_path": "action_result.data.*.accountEnabled", "data_type": "boolean", "example_values": [ true ] }, { "data_path": "action_result.data.*.ageGroup", "data_type": "string" }, { "data_path": "action_result.data.*.assignedLicenses.*.skuId", "data_type": "string", "example_values": [ "189a915c-fe4f-4ffa-bde4-85b9628d07a0" ] }, { "data_path": "action_result.data.*.assignedPlans.*.assignedDateTime", "data_type": "string", "example_values": [ "2022-11-03T15:12:28Z" ] }, { "data_path": "action_result.data.*.assignedPlans.*.capabilityStatus", "data_type": "string", "example_values": [ "Deleted" ] }, { "data_path": "action_result.data.*.assignedPlans.*.service", "data_type": "string", "example_values": [ "AADPremiumService" ] }, { "data_path": "action_result.data.*.assignedPlans.*.servicePlanId", "data_type": "string", "example_values": [ "eec0eb4f-6444-4f95-aba0-50c24d67f998" ] }, { "data_path": "action_result.data.*.city", "data_type": "string", "example_values": [ "Palo Alto" ] }, { "data_path": "action_result.data.*.companyName", "data_type": "string" }, { "data_path": "action_result.data.*.consentProvidedForMinor", "data_type": "string" }, { "data_path": "action_result.data.*.country", "data_type": "string", "example_values": [ "US" ] }, { "data_path": "action_result.data.*.createdDateTime", "data_type": "string", "example_values": [ "2016-06-09T18:33:27Z" ] }, { "data_path": "action_result.data.*.creationType", "data_type": "string" }, { "data_path": "action_result.data.*.deletedDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.department", "data_type": "string" }, { "data_path": "action_result.data.*.displayName", "data_type": "string", "example_values": [ "Firstname Lastname" ], "column_name": "Display Name", "column_order": 0 }, { "data_path": "action_result.data.*.employeeHireDate", "data_type": "string" }, { "data_path": "action_result.data.*.employeeId", "data_type": "string" }, { "data_path": "action_result.data.*.employeeOrgData", "data_type": "string" }, { "data_path": "action_result.data.*.employeeType", "data_type": "string" }, { "data_path": "action_result.data.*.externalUserState", "data_type": "string" }, { "data_path": "action_result.data.*.externalUserStateChangeDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.faxNumber", "data_type": "string" }, { "data_path": "action_result.data.*.givenName", "data_type": "string" }, { "data_path": "action_result.data.*.id", "data_type": "string", "example_values": [ "17be76d0-35ed-4881-ab62-d2eb73c2ebe3" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.identities.*.issuer", "data_type": "string", "example_values": [ "test.com" ] }, { "data_path": "action_result.data.*.identities.*.issuerAssignedId", "data_type": "string", "example_values": [ "test@user.test.com" ] }, { "data_path": "action_result.data.*.identities.*.signInType", "data_type": "string", "example_values": [ "userPrincipalName" ] }, { "data_path": "action_result.data.*.isResourceAccount", "data_type": "string" }, { "data_path": "action_result.data.*.jobTitle", "data_type": "string" }, { "data_path": "action_result.data.*.legalAgeGroupClassification", "data_type": "string" }, { "data_path": "action_result.data.*.mail", "data_type": "string" }, { "data_path": "action_result.data.*.mailNickname", "data_type": "string", "example_values": [ "User" ] }, { "data_path": "action_result.data.*.mobilePhone", "data_type": "string" }, { "data_path": "action_result.data.*.officeLocation", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesDistinguishedName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesDomainName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute1", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute10", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute11", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute12", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute13", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute14", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute15", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute2", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute3", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute4", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute5", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute6", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute7", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute8", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesExtensionAttributes.extensionAttribute9", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesImmutableId", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesLastSyncDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSamAccountName", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSecurityIdentifier", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.onPremisesUserPrincipalName", "data_type": "string" }, { "data_path": "action_result.data.*.passwordPolicies", "data_type": "string" }, { "data_path": "action_result.data.*.passwordProfile", "data_type": "string" }, { "data_path": "action_result.data.*.postalCode", "data_type": "string", "example_values": [ "94303" ] }, { "data_path": "action_result.data.*.preferredDataLocation", "data_type": "string" }, { "data_path": "action_result.data.*.preferredLanguage", "data_type": "string" }, { "data_path": "action_result.data.*.provisionedPlans.*.capabilityStatus", "data_type": "string", "example_values": [ "Enabled" ] }, { "data_path": "action_result.data.*.provisionedPlans.*.provisioningStatus", "data_type": "string", "example_values": [ "Success" ] }, { "data_path": "action_result.data.*.provisionedPlans.*.service", "data_type": "string", "example_values": [ "testCommunicationsOnline" ] }, { "data_path": "action_result.data.*.refreshTokensValidFromDateTime", "data_type": "string", "example_values": [ "2022-08-08T13:00:58Z" ] }, { "data_path": "action_result.data.*.showInAddressList", "data_type": "string" }, { "data_path": "action_result.data.*.signInSessionsValidFromDateTime", "data_type": "string", "example_values": [ "2022-08-08T13:00:58Z" ] }, { "data_path": "action_result.data.*.state", "data_type": "string", "example_values": [ "CA" ] }, { "data_path": "action_result.data.*.streetAddress", "data_type": "string", "example_values": [ "2479 E. Bayshore Rd." ] }, { "data_path": "action_result.data.*.surname", "data_type": "string" }, { "data_path": "action_result.data.*.usageLocation", "data_type": "string", "example_values": [ "US" ] }, { "data_path": "action_result.data.*.userPrincipalName", "data_type": "string", "example_values": [ "ews_retest@test.com" ] }, { "data_path": "action_result.data.*.userType", "data_type": "string", "example_values": [ "Member" ] }, { "data_path": "action_result.summary.num_members", "data_type": "numeric", "example_values": [ 3 ], "contains": [ "user id" ] }, { "data_path": "action_result.summary.num_users", "data_type": "numeric", "example_values": [ 3 ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Num members: 3" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "custom", "title": "list group members", "view": "msadgraph_view.display_view" }, "versions": "EQ(*)" }, { "action": "validate group", "description": "Returns true if a user is in a group; otherwise, false", "type": "investigate", "identifier": "validate_group", "read_only": true, "parameters": { "group_object_id": { "description": "Object ID of group", "data_type": "string", "required": true, "primary": true, "order": 0, "contains": [ "group object id" ] }, "user_id": { "description": "User ID to validate", "data_type": "string", "required": true, "primary": true, "order": 1, "contains": [ "user id" ] } }, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 2 }, { "data_path": "action_result.parameter.group_object_id", "data_type": "string", "example_values": [ "ebcd3130-55a1-4cbf-81b2-86408ff21203" ], "contains": [ "group object id" ], "column_name": "Group Object ID", "column_order": 0 }, { "data_path": "action_result.parameter.user_id", "data_type": "string", "example_values": [ "user@test.com" ], "contains": [ "user id" ], "column_name": "User ID", "column_order": 1 }, { "data_path": "action_result.data.*.@odata.context", "data_type": "string", "example_values": [ "https://graph.test.com/v1.0/$metadata#directoryObjects" ] }, { "data_path": "action_result.data.*.user_in_group", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.@odata.type", "data_type": "string", "example_values": [ "#test.graph.group" ] }, { "data_path": "action_result.data.*.value.*.classification", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.createdDateTime", "data_type": "string", "example_values": [ "2022-02-25T12:05:22Z" ] }, { "data_path": "action_result.data.*.value.*.deletedDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.description", "data_type": "string", "example_values": [ "Test group for MSGraph" ] }, { "data_path": "action_result.data.*.value.*.displayName", "data_type": "string", "example_values": [ "Test group for MSGraph" ] }, { "data_path": "action_result.data.*.value.*.expirationDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.id", "data_type": "string", "example_values": [ "49233413-24c6-4516-a9e1-4d5f87fe34fd" ], "contains": [ "user id" ] }, { "data_path": "action_result.data.*.value.*.isAssignableToRole", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.mail", "data_type": "string", "example_values": [ "test@user.test.com" ] }, { "data_path": "action_result.data.*.value.*.mailEnabled", "data_type": "boolean", "example_values": [ true ] }, { "data_path": "action_result.data.*.value.*.mailNickname", "data_type": "string", "example_values": [ "TestgroupforMSGraph" ] }, { "data_path": "action_result.data.*.value.*.membershipRule", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.membershipRuleProcessingState", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.onPremisesDomainName", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.onPremisesLastSyncDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.onPremisesNetBiosName", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.onPremisesSamAccountName", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.onPremisesSecurityIdentifier", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.onPremisesSyncEnabled", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.preferredDataLocation", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.preferredLanguage", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.renewedDateTime", "data_type": "string", "example_values": [ "2022-02-25T12:05:22Z" ] }, { "data_path": "action_result.data.*.value.*.securityEnabled", "data_type": "boolean", "example_values": [ true ] }, { "data_path": "action_result.data.*.value.*.securityIdentifier", "data_type": "string", "example_values": [ "S-1-12-1-1227043859-1159079110-1598939561-4248108679" ] }, { "data_path": "action_result.data.*.value.*.theme", "data_type": "string" }, { "data_path": "action_result.data.*.value.*.visibility", "data_type": "string", "example_values": [ "Private" ] }, { "data_path": "action_result.summary.message", "data_type": "string", "example_values": [ "User is member of group" ] }, { "data_path": "action_result.summary.user_in_group", "data_type": "string" }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "User in group: True" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "table" }, "versions": "EQ(*)" }, { "action": "list directory roles", "description": "List the directory roles that are activated in the tenant", "verbose": "

Pagination is not implemented for this action as this endpoint does not support pagination. Here is the Documentation for the same.

", "type": "investigate", "identifier": "list_directory_roles", "read_only": true, "parameters": {}, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ] }, { "data_path": "action_result.data.*.deletedDateTime", "data_type": "string" }, { "data_path": "action_result.data.*.deletionTimestamp", "data_type": "string" }, { "data_path": "action_result.data.*.description", "data_type": "string", "example_values": [ "Can read basic directory information. For granting access to applications, not intended for users." ] }, { "data_path": "action_result.data.*.displayName", "data_type": "string", "example_values": [ "Directory Readers" ], "column_name": "Display Name", "column_order": 0 }, { "data_path": "action_result.data.*.id", "data_type": "string", "example_values": [ "02b238cb-0d15-454b-aae6-0e94993a3207" ], "contains": [ "directory object id" ], "column_name": "Object ID", "column_order": 1 }, { "data_path": "action_result.data.*.isSystem", "data_type": "boolean", "example_values": [ true, false ] }, { "data_path": "action_result.data.*.objectType", "data_type": "string", "example_values": [ "Role" ] }, { "data_path": "action_result.data.*.odata.type", "data_type": "string", "example_values": [ "test.DirectoryServices.DirectoryRole" ] }, { "data_path": "action_result.data.*.roleTemplateId", "data_type": "string", "example_values": [ "88d8e3e3-8f55-4a1e-953a-9b9898b8876b" ], "contains": [ "role template id" ] }, { "data_path": "action_result.summary.num_directory_roles", "data_type": "numeric", "example_values": [ 9 ] }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Num directory roles: 9" ] }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "table" }, "versions": "EQ(*)" }, { "action": "generate token", "identifier": "generate_token", "description": "Generate a token", "type": "generic", "read_only": false, "parameters": {}, "output": [ { "data_path": "action_result.status", "data_type": "string", "example_values": [ "success", "failed" ], "column_name": "Status", "column_order": 0 }, { "data_path": "action_result.data", "data_type": "string" }, { "data_path": "action_result.summary", "data_type": "string" }, { "data_path": "action_result.message", "data_type": "string", "example_values": [ "Token generated" ], "column_name": "Message", "column_order": 1 }, { "data_path": "summary.total_objects", "data_type": "numeric", "example_values": [ 1 ] }, { "data_path": "summary.total_objects_successful", "data_type": "numeric", "example_values": [ 1 ] } ], "render": { "type": "table" }, "versions": "EQ(*)" } ], "pip_dependencies": { "wheel": [ { "module": "beautifulsoup4", "input_file": "wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl" }, { "module": "soupsieve", "input_file": "wheels/py3/soupsieve-2.3.2.post1-py3-none-any.whl" } ] }, "pip39_dependencies": { "wheel": [ { "module": "beautifulsoup4", "input_file": "wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl" }, { "module": "soupsieve", "input_file": "wheels/py3/soupsieve-2.4.1-py3-none-any.whl" } ] } }