--- title: "Azure" slug: "azure" updated: 2023-04-18T16:40:49Z published: 2023-04-18T16:40:49Z canonical: "help.rapididentity.com/azure" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.rapididentity.com/llms.txt > Use this file to discover all available pages before exploring further. # Azure The Azure Adapter contains actions that manage users and groups within Azure [AddAzureGroupMember](/docs/azure#addazuregroupmember) [AssignAzureUserLicenses](/docs/azure#assignazureuserlicenses) [CreateAzureGroup](/docs/azure#createazuregroup) [CreateAzureUser](/docs/azure#createazureuser) [DefineAzureConnection](/docs/azure#defineazureconnection) [GetAzureGroupMembers](/docs/azure#getazuregroupmembers) [GetAzureLicense](/docs/azure#getazurelicense) [GetAzureLicenses](/docs/azure#getazurelicenses) [GetAzureUser](/docs/azure#getazureuser) [GetAzureUserLicenses](/docs/azure#getazureuserlicenses) [RemoveAzureGroupMember](/docs/azure#removeazuregroupmember) [SearchAzureGroup](/docs/azure#searchazuregroup) [UpdateAzureUser](/docs/azure#updateazureuser) ## AddAzureGroupMember The `AddAzureGroupMember` adds the specified user to the specified group as a member ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### userID: string The Azure ID of the user #### groupID: string The Azure ID of the group ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful RapidIdentity HTTP Response. An example is below: ``` { "data": null, "finalURL": "https://graph.microsoft.com/v1.0/groups/208f5546-f743-459d-8e36-ed7591fa31da/members/$ref", "headers": { "Cache-Control": "no-cache", "client-request-id": "226a8aba-2b36-49df-b026-32fce098228d", "Date": "Mon, 20 Mar 2023 15:37:13 GMT", "request-id": "226a8aba-2b36-49df-b026-32fce098228d", "Strict-Transport-Security": "max-age=31536000", "x-ms-ags-diagnostic": "{\"ServerInfo\":{\"DataCenter\":\"East US\",\"Slice\":\"E\",\"Ring\":\"5\",\"ScaleUnit\":\"002\",\"RoleInstance\":\"BL02EPF000028B1\"}}", "x-ms-resource-unit": "1" }, "initialURL": "https://graph.microsoft.com/v1.0/groups/208f5546-f743-459d-8e36-ed7591fa31da/members/$ref", "statusCode": 204, "statusReason": "No Content" } ``` #### Unsuccessful An Azure Graph [error](https://learn.microsoft.com/en-us/graph/errors). An example is below: ``` { "code": "Request_BadRequest", "message": "Invalid object identifier 'djay@example.com'.", "innerError": { "date": "2023-03-20T15:35:49", "request-id": "2c829664-9e8a-4030-b824-68d4c77157bf", "client-request-id": "2c829664-9e8a-4030-b824-68d4c77157bf" } } ``` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") result = AddAzureGroupMember(sessionAzure,"12345678-1234-1234-1234-123456789012","87654321-4321-4321-4321-210987654321") ``` ## AssignAzureUserLicenses The `AssignAzureUserLicenses` action adds and/or remove licenses from a user in Microsoft Azure ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### azure_id: string The userPrincipalName or id of the user #### license_record: object The azure license record to add and/or remove ``` { "addLicenses": [ { "disabledPlans": ["guid"], "skuId": "guid" } ], "removeLicenses": ["guid"] } ``` ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful An azure [user resource type](%22https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#json-representation%22). An example is below: ``` { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity", "businessPhones": [], "displayName": "Daniel Day", "givenName": "Daniel", "jobTitle": null, "mail": "DDay@example.com", "mobilePhone": null, "officeLocation": null, "preferredLanguage": "en-US", "surname": "Day", "userPrincipalName": "DDay@example.com", "id": "12345678-1234-1234-1234-123456789012" } ``` #### Unsuccessful A boolean of `false` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") license_record = { "addLicenses": [ { "skuId": "12345678-1234-1234-1234-123456789012" } ], "removeLicenses": ["87654321-4321-4321-4321-210987654321"] } result = AssignAzureUserLicenses(sessionAzure,"dday@example.com",license_record) ``` ## CreateAzureGroup The `CreateAzureGroup` action creates a Microsoft 365 group or a security group in Azure. Distribution lists and Mail-enable security groups are not supported. ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### record: object A [group](%22https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0%22) record ``` { "description": "Self help community for library", "displayName": "Library Assist", "groupTypes": [ "Unified" ], "mailEnabled": true, "mailNickname": "library", "securityEnabled": false } ``` ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful An azure [group resource type](%22https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0%22). An example is below: ``` { "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd", "deletedDateTime": null, "classification": null, "createdDateTime": "2018-12-22T00:51:37Z", "description": "Self help community for library", "displayName": "Library Assist", "groupTypes": [ "Unified" ], "mail": "library7423@example.com", "mailEnabled": true, "mailNickname": "library", "onPremisesLastSyncDateTime": null, "onPremisesSecurityIdentifier": null, "onPremisesSyncEnabled": null, "preferredDataLocation": "CAN", "proxyAddresses": [ "SMTP:library7423@example.com" ], "renewedDateTime": "2018-12-22T00:51:37Z", "resourceBehaviorOptions": [], "resourceProvisioningOptions": [], "securityEnabled": false, "visibility": "Public", "onPremisesProvisioningErrors": [] } ``` #### Unsuccessful An Azure Graph [error](https://learn.microsoft.com/en-us/graph/errors). An example is below: ``` { "error": { "code": "Request_BadRequest", "message": "A value is required for property 'mailEnabled' of resource 'Group'.", "innerError": { "date": "2023-04-03T19:47:08", "request-id": "01f5205c-946a-4fb9-8487-cce7494a384b", "client-request-id": "01f5205c-946a-4fb9-8487-cce7494a384b" } } } ``` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") record = createRecordFromObject({ "description": "Self help community for library", "displayName": "Library Assist", "mailEnabled": true, "mailNickname": "library", "securityEnabled": false }) setRecordFieldValue(record, "groupTypes", ["Unified"]) result = CreateAzureGroup(sessionAzure,record) ``` ## CreateAzureUser The `CreateAzureUser` action creates a user in azure active directory. ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### record: object A [user](%22https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0%22) record ``` { "accountEnabled": true, "displayName": "Adele Vance", "mailNickname": "AdeleV", "userPrincipalName": "AdeleV@example.com", "passwordProfile" : { "forceChangePasswordNextSignIn": true, "password": "xWwvJ]6NMw+bWH-d" } } ``` ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful An azure [user resource type](%22https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0%22). An example is below: ``` { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity", "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd", "businessPhones": [], "displayName": "Adele Vance", "givenName": "Adele", "jobTitle": "Product Marketing Manager", "mail": "AdeleV@example.com", "mobilePhone": "+1 425 555 0109", "officeLocation": "18/2111", "preferredLanguage": "en-US", "surname": "Vance", "userPrincipalName": "AdeleV@example.com" } ``` #### Unsuccessful An Azure Graph [error](https://learn.microsoft.com/en-us/graph/errors). An example is below: ``` { "code": "Request_BadRequest", "message": "A password must be specified to create a new user.", "innerError": { "date": "2023-04-03T23:41:42", "request-id": "a1a90294-db1b-4883-a86a-8f07f81edacf", "client-request-id": "a1a90294-db1b-4883-a86a-8f07f81edacf" } } ``` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") record = createRecordFromObject({ "accountEnabled": true, "displayName": "Adele Vance", "mailNickname": "AdeleV", "userPrincipalName": "AdeleV@example.com", "passwordProfile" : { "forceChangePasswordNextSignIn": true, "password": "xWwvJ]6NMw+bWH-d" } }) result = CreateAzureUser(sessionAzure,record) ``` ## DefineAzureConnection The `DefineAzureConnection` action retrieves an access token that is used as authentication for all Azure actions ### Input Parameters #### client_id: string The client id of your application registration #### client_secret: password The client secret of your application registration #### tenant: string The tenant id you want to connect #### resource: string The resource you want access. This can either be `graph.microsoft.com` or `management.azure.com` ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful An Azure access token #### Unsuccessful A boolean of `false` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") record = createRecordFromObject({ "accountEnabled": true, "displayName": "Adele Vance", "mailNickname": "AdeleV", "userPrincipalName": "AdeleV@example.com", "passwordProfile" : { "forceChangePasswordNextSignIn": true, "password": "xWwvJ]6NMw+bWH-d" } }) result = CreateAzureUser(sessionAzure,record) ``` ## GetAzureGroupMembers The `GetAzureGroupMembers` action retrieves all members of an Azure group ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### groupID: string The guid of the group to retrieve ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful An array of members userPrincipalName. #### Unsuccessful An Azure Graph [error](https://learn.microsoft.com/en-us/graph/errors). An example is below: ``` { "code": "Request_BadRequest", "innerError": { "client-request-id": "73ea2f47-df96-4d02-aede-fcfe146ead46", "date": "2023-04-04T00:06:17", "request-id": "73ea2f47-df96-4d02-aede-fcfe146ead46" }, "message": "Invalid object identifier '61c63fac-3595-4792-af55-9b47'." } ``` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") members = GetAzureGroupMembers(sessionAzure,"12345678-1234-1234-1234-123456789012") forEach(upn, members) { log(upn) // Logs member userPrincipalName } ``` ## GetAzureLicense The `GetAzureLicense` action retrieves an Azure license by the Azure SKU ID ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### id: string The id of the SKU. ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful An Azure [subscribedSku resource type](%22https://learn.microsoft.com/en-us/graph/api/resources/subscribedsku?view=graph-rest-1.0%22). An example is below ``` { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#subscribedSkus/$entity", "capabilityStatus": "Enabled", "consumedUnits": 14, "id": "48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df", "prepaidUnits": { "enabled": 25, "suspended": 0, "warning": 0 }, "servicePlans": [ { "servicePlanId": "8c098270-9dd4-4350-9b30-ba4703f3b36b", "servicePlanName": "ADALLOM_S_O365", "provisioningStatus": "Success", "appliesTo": "User" }, { "servicePlanId": "9f431833-0334-42de-a7dc-70aa40db46db", "servicePlanName": "LOCKBOX_ENTERPRISE", "provisioningStatus": "Success", "appliesTo": "User" } ], "skuId": "c7df2760-2c81-4ef7-b578-5b5392b571df", "skuPartNumber": "ENTERPRISEPREMIUM", "appliesTo": "User" } ``` #### Unsuccessful A boolean value of `false` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") license = GetAzureLicense(sessionAzure,"12345678-1234-1234-1234-123456789012_87654321-4321-4321-4321-210987654321") ``` ## GetAzureLicenses The `GetAzureLicenses` action retrieves all license skus for the Azure tenant ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful A collection of Azure [subscribedSku resource type](%22https://learn.microsoft.com/en-us/graph/api/resources/subscribedsku?view=graph-rest-1.0%22). An example is below ``` [ { "capabilityStatus": "Enabled", "consumedUnits": 14, "id": "48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df", "prepaidUnits": { "enabled": 25, "suspended": 0, "warning": 0 }, "servicePlans": [ { "servicePlanId": "8c098270-9dd4-4350-9b30-ba4703f3b36b", "servicePlanName": "ADALLOM_S_O365", "provisioningStatus": "Success", "appliesTo": "User" } ], "skuId": "c7df2760-2c81-4ef7-b578-5b5392b571df", "skuPartNumber": "ENTERPRISEPREMIUM", "appliesTo": "User" }, { "capabilityStatus": "Suspended", "consumedUnits": 14, "id": "48a80680-7326-48cd-9935-b556b81d3a4e_d17b27af-3f49-4822-99f9-56a661538792", "prepaidUnits": { "enabled": 0, "suspended": 25, "warning": 0 }, "servicePlans": [ { "servicePlanId": "f9646fb2-e3b2-4309-95de-dc4833737456", "servicePlanName": "CRMSTANDARD", "provisioningStatus": "Disabled", "appliesTo": "User" } ], "skuId": "d17b27af-3f49-4822-99f9-56a661538792", "skuPartNumber": "CRMSTANDARD", "appliesTo": "User" } ] ``` #### Unsuccessful A boolean value of `false` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") license = GetAzureLicenses(sessionAzure) ``` ## GetAzureUser The `GetAzureUser` action retrieves a user by id or userPrincipalName ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### userPrincipalName: string The userPrincipalName or id of the user to retrieve ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful A collection of Azure [user resource type](%22https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0%22). An example is below ``` { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users(accountEnabled,ageGroup,assignedLicenses,businessPhones,city,companyName,consentProvidedForMinor,country,createdDateTime,creationType,department,displayName,givenName,id,identities,jobTitle,lastPasswordChangeDateTime,legalAgeGroupClassification,licenseAssignmentStates,mail,mobilePhone,officeLocation,onPremisesDistinguishedName,onPremisesDomainName,onPremisesExtensionAttributes,onPremisesImmutableId,onPremisesLastSyncDateTime,onPremisesProvisioningErrors,onPremisesSamAccountName,onPremisesSecurityIdentifier,onPremisesUserPrincipalName,otherMails,passwordPolicies,postalCode,preferredLanguage,provisionedPlans,proxyAddresses,refreshTokensValidFromDateTime,showInAddressList,signInSessionsValidFromDateTime,state,streetAddress,surname,usageLocation,userPrincipalName,userType,immutableID)/$entity", "accountEnabled": true, "ageGroup": null, "businessPhones": [], "city": null, "companyName": null, "consentProvidedForMinor": null, "country": null, "createdDateTime": "2021-09-17T16:18:13Z", "creationType": null, "department": null, "displayName": "Ashley Arnold", "givenName": "Ashley", "id": "12345678-1234-1234-1234-123456789012", "jobTitle": null, "lastPasswordChangeDateTime": null, "legalAgeGroupClassification": null, "mail": "AArnold@example.com", "mobilePhone": null, "officeLocation": null, "onPremisesDistinguishedName": null, "onPremisesDomainName": null, "onPremisesImmutableId": "12345678-1234-1234-1234-123456789012", "onPremisesLastSyncDateTime": null, "onPremisesSamAccountName": null, "onPremisesSecurityIdentifier": null, "onPremisesUserPrincipalName": null, "otherMails": [], "passwordPolicies": null, "postalCode": null, "preferredLanguage": "en-US", "proxyAddresses": [ "SMTP:AArnold@example.com" ], "refreshTokensValidFromDateTime": null, "showInAddressList": null, "signInSessionsValidFromDateTime": null, "state": null, "streetAddress": null, "surname": "Arnold", "usageLocation": "US", "userPrincipalName": "AArnold@example.com", "userType": "Member", "assignedLicenses": [], "identities": [ { "signInType": "userPrincipalName", "issuer": "example.onmicrosoft.com", "issuerAssignedId": "AArnold@example.com" } ], "licenseAssignmentStates": [], "onPremisesExtensionAttributes": { "extensionAttribute1": null, "extensionAttribute2": null, "extensionAttribute3": null, "extensionAttribute4": null, "extensionAttribute5": null, "extensionAttribute6": null, "extensionAttribute7": null, "extensionAttribute8": null, "extensionAttribute9": null, "extensionAttribute10": null, "extensionAttribute11": null, "extensionAttribute12": null, "extensionAttribute13": null, "extensionAttribute14": null, "extensionAttribute15": null }, "onPremisesProvisioningErrors": [], "provisionedPlans": [ { "capabilityStatus": "Deleted", "provisioningStatus": "Success", "service": "exchange" }, { "capabilityStatus": "Deleted", "provisioningStatus": "Success", "service": "exchange" }, { "capabilityStatus": "Deleted", "provisioningStatus": "Success", "service": "MicrosoftCommunicationsOnline" }, { "capabilityStatus": "Deleted", "provisioningStatus": "Success", "service": "SharePoint" }, { "capabilityStatus": "Deleted", "provisioningStatus": "Success", "service": "SharePoint" } ] } ``` #### Unsuccessful A boolean value of `false` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") license = GetAzureUser(sessionAzure, "aarnold@example.com) ``` ## GetAzureUserLicenses The `GetAzureUserLicenses` action retrieves all license skus for a specific user by userPrincipalName or id ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### azureUserID: string The userPrincipalName or id of the Azure user ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful A collection of Azure [subscribedSku resource type](%22https://learn.microsoft.com/en-us/graph/api/resources/subscribedsku?view=graph-rest-1.0%22). An example is below ``` [ { "capabilityStatus": "Enabled", "consumedUnits": 14, "id": "48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df", "prepaidUnits": { "enabled": 25, "suspended": 0, "warning": 0 }, "servicePlans": [ { "servicePlanId": "8c098270-9dd4-4350-9b30-ba4703f3b36b", "servicePlanName": "ADALLOM_S_O365", "provisioningStatus": "Success", "appliesTo": "User" } ], "skuId": "c7df2760-2c81-4ef7-b578-5b5392b571df", "skuPartNumber": "ENTERPRISEPREMIUM", "appliesTo": "User" }, { "capabilityStatus": "Suspended", "consumedUnits": 14, "id": "48a80680-7326-48cd-9935-b556b81d3a4e_d17b27af-3f49-4822-99f9-56a661538792", "prepaidUnits": { "enabled": 0, "suspended": 25, "warning": 0 }, "servicePlans": [ { "servicePlanId": "f9646fb2-e3b2-4309-95de-dc4833737456", "servicePlanName": "CRMSTANDARD", "provisioningStatus": "Disabled", "appliesTo": "User" } ], "skuId": "d17b27af-3f49-4822-99f9-56a661538792", "skuPartNumber": "CRMSTANDARD", "appliesTo": "User" } ] ``` #### Unsuccessful A boolean value of `false` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") license = GetAzureUserLicenses(sessionAzure, aarnold@example.com) ``` ## RemoveAzureGroupMember The `RemoveAzureGroupMember` action removes the specified user to the specified group as a member ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### userID: string The Azure ID of the user #### groupID: string The Azure ID of the group ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful RapidIdentity HTTP Response. An example is below: ``` { "data": null, "finalURL": "https://graph.microsoft.com/v1.0/groups/208f5546-f743-459d-8e36-ed7591fa31da/members/8fce7267-0b56-4d71-a24d-a3f073b35440/$ref", "headers": { "Cache-Control": "no-cache", "client-request-id": "2c742bb6-2c6b-4765-be3d-6e4fcbd9148b", "Date": "Wed, 12 Apr 2023 18:22:19 GMT", "request-id": "2c742bb6-2c6b-4765-be3d-6e4fcbd9148b", "Strict-Transport-Security": "max-age=31536000", "x-ms-ags-diagnostic": "{\"ServerInfo\":{\"DataCenter\":\"South Central US\",\"Slice\":\"E\",\"Ring\":\"5\",\"ScaleUnit\":\"000\",\"RoleInstance\":\"SN1PEPF00020FD3\"}}", "x-ms-resource-unit": "1" }, "initialURL": "https://graph.microsoft.com/v1.0/groups/208f5546-f743-459d-8e36-ed7591fa31da/members/8fce7267-0b56-4d71-a24d-a3f073b35440/$ref", "statusCode": 204, "statusReason": "No Content" } ``` #### Unsuccessful An Azure Graph [error](https://learn.microsoft.com/en-us/graph/errors). An example is below: ``` { "code": "Request_UnsupportedQuery", "message": "Unsupported referenced-object resource identifier for link property 'members'.", "innerError": { "date": "2023-04-12T18:21:09", "request-id": "8f0bd7f0-50e1-4cb7-b248-658e45d9cf8b", "client-request-id": "8f0bd7f0-50e1-4cb7-b248-658e45d9cf8b" } } ``` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") result = RemoveAzureGroupMember(sessionAzure,"12345678-1234-1234-1234-123456789012","87654321-4321-4321-4321-210987654321") ``` ## SearchAzureGroup The `SearchAzureGroup` action retrieves groups based on a specified filter ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### filter: enum The field to filter on. Currently the accepted values are displayName, mailNickname, id, groupTypes #### value: string The value to search based on the specified filter. This will match with groups that ***start with*** this value ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful A collection of Azure [group resource type](%22https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0%22). An example is below ``` [ { "id": "45b7d2e7-b882-4a80-ba97-10b7a63b8fa4", "deletedDateTime": null, "classification": null, "createdDateTime": "2018-12-22T02:21:05Z", "description": "Self help community for golf", "displayName": "Golf Assist", "expirationDateTime": null, "groupTypes": [ "Unified" ], "isAssignableToRole": null, "mail": "golfassist@contoso.com", "mailEnabled": true, "mailNickname": "golfassist", "membershipRule": null, "membershipRuleProcessingState": null, "onPremisesLastSyncDateTime": null, "onPremisesSecurityIdentifier": null, "onPremisesSyncEnabled": null, "preferredDataLocation": "CAN", "preferredLanguage": null, "proxyAddresses": [ "smtp:golfassist@contoso.onmicrosoft.com", "SMTP:golfassist@contoso.com" ], "renewedDateTime": "2018-12-22T02:21:05Z", "resourceBehaviorOptions": [], "resourceProvisioningOptions": [], "securityEnabled": false, "theme": null, "visibility": "Public", "onPremisesProvisioningErrors": [] }, { "id": "d7797254-3084-44d0-99c9-a3b5ab149538", "deletedDateTime": null, "classification": null, "createdDateTime": "2018-11-19T20:29:40Z", "description": "Talk about golf", "displayName": "Golf Discussion", "expirationDateTime": null, "groupTypes": [], "isAssignableToRole": null, "mail": "golftalk@contoso.com", "mailEnabled": true, "mailNickname": "golftalk", "membershipRule": null, "membershipRuleProcessingState": null, "onPremisesLastSyncDateTime": null, "onPremisesSecurityIdentifier": null, "onPremisesSyncEnabled": null, "preferredDataLocation": "CAN", "preferredLanguage": null, "proxyAddresses": [ "smtp:golftalk@contoso.onmicrosoft.com", "SMTP:golftalk@contoso.com" ], "renewedDateTime": "2018-11-19T20:29:40Z", "resourceBehaviorOptions": [], "resourceProvisioningOptions": [], "securityEnabled": false, "theme": null, "visibility": null, "onPremisesProvisioningErrors": [] } ] ``` #### Unsuccessful A boolean value of `false` ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") groups = SearchAzureGroup(sessionAzure, "displayName", "All") ``` ## UpdateAzureUser The `UpdateAzureUser` action updates a user in azure active directory. ### Input Parameters #### token: password The access token received from the `DefineAzureConnection` action #### userPrincipalName: string The userPrincipalName or id of the user to update #### record: object A [user](%22https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0%22) record ``` { "accountEnabled": true, "displayName": "Adele Vance", "mailNickname": "AdeleV", "userPrincipalName": "AdeleV@example.com", "passwordProfile" : { "forceChangePasswordNextSignIn": true, "password": "xWwvJ]6NMw+bWH-d" } } ``` ### Return Value This action set provides 2 responses based on whether the action is successful or unsuccessful #### Successful A boolean value of true #### Unsuccessful A boolean value of false ### Example ``` sessionAzure = DefineAzureConnection("12345678-1234-1234-1234-123456789012", "secret", "87654321-4321-4321-4321-210987654321", "graph.microsoft.com") user = GetAzureUser(sessionAzure, "aadams@example.com") record = createRecordFromObject({ "displayName": "April Lee" }) result = UpdateAzureUser(sessionAzure, user.userPrincipalName, record) ```