Azure AD

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This section lists some of the actions supported by the connector. To understand how to configure the actions, see Action examples.

AddGroupMember action

This action adds a member to a group.

Input parameters of the AddGroupMember action

For an example about how to configure this action, see Action examples.

RemoveGroupMember action

This action removes a member from a group.

Input parameters of the RemoveGroupMember action

For an example about how to configure this action, see Examples.

AddGroupMember(Guest Account) action

This action adds a member to a group.

Input parameters of the AddGroupMember action

For an example about how to configure this action, see Examples.

RemoveGroupMember (Guest Account) action

This action removes a member from a group

Input parameters of the RemoveGroupMember action

For an example about how to configure this action, see Examples.

AddUserApplicationRoleAssignment action

This action adds a user to an Application Role Assignment.

Input parameters of the AddUserApplicationRoleAssignment action

For an example about how to configure this action, see Examples.

RemoveUserApplicationRoleAssignment action

This action removes a user from an Application Role Assignment.

Input parameters of the RemoveUserApplicationRoleAssignment action

For an example about how to configure this action, see Examples.

AddGroupApplicationRoleAssignment action

This action adds a group to an Application Role Assignment./p>

Input parameters of the AddGroupApplicationRoleAssignment action

For an example about how to configure this action, see Examples.

RemoveGroupApplicationRoleAssignment action

This action removes a group from an Application Role Assignment.

Input parameters of the RemoveGroupApplicationRoleAssignment action

For an example about how to configure this action, see Examples.

ActivateDirectoryRole action

This action activates a directory role.

Input parameters of the ActivateDirectoryRole action

For an example about how to configure this action, see Examples.

VerifyDomain action

This action verifies a domain.

Input parameters of the VerifyDomain action

For an example about how to configure this action, see Examples.

ChangePassword action

This action changes the password of a user.

Input parameters of the ChangePassword action

For an example about how to configure this action, see Examples.

ResetPassword action

This action resets the password of a user.

Input parameters of the ResetPassword action

For an example about how to configure this action, see Examples.

AssignLicense action

This action assigns a license to a user.

Input parameters of the AssignLicense action

For an example about how to configure this action, see Examples.

RemoveLicense action

This action removes the license assigned to a user.

Input parameters of the RemoveLicense action

For an example about how to configure this action, see Examples.

FetchAdditionalUserFields action

This action retrieves mandatory attribute fields.

Input parameters of the FetchAdditionalUserFields action

For an example about how to configure this action, see Examples.

AddGroupOwner action

This action adds a owner to a group.

Input parameters of the AddGroupOwner action

For an example about how to configure this action, see Examples.

RemoveGroupOwner action

This action removes a group owner.

Input parameters of the RemoveGroupOwner action

For an example about how to configure this action, see Examples.

InviteExternalUser action

This action invites an external user to the organization.

Input parameters of the InviteExternalUser action

For an example about how to configure this action, see Examples.

AddPhoneAuthenticationMethod action

This action let users perform specific tasks

Input parameters of the AddPhoneAuthenticationMethod action

For an example about how to configure this action, see Examples.

RemovePhoneAuthenticationMethod action

This action removes the phone authentication method for a user.

Input parameters of the RemovePhoneAuthenticationMethod action

For an example about how to configure this action, see Examples.

UpdatePhoneAuthenticationMethod action

This action updates the phone authentication method for a user.

Input parameters of the UpdatePhoneAuthenticationMethod action

For an example about how to configure this action, see Examples.

AddPrivilegedRole action

This action adds a privileged role for a user.

Input parameters of the AddPrivilegedRole action

For an example about how to configure this action, see Examples.

RemovePrivilegedRole action

This action removes the privileged role for a user.<

Input parameters of the RemovePrivilegedRole action

RetrieveUserPhoto action

This action retrieves a user photo.

Input parameters of the RetrieveUserPhoto action

For an example about how to configure this action, see Examples.

UpdateUserPhoto action

This action updates a user photo.

Input parameters of the UpdateUserPhoto action

For an example about how to configure this action, see Examples.

RemoveUserPhoto action

This action removes a user photo.

Input parameters of the RemoveUserPhoto action

For an example about how to configure this action, see Examples.

AssignManager action

This action assigns a manager to a particular user.

Input parameters of the AssignManager action

For an example about how to configure this action, see Examples.

RemoveManager action

This action removes the manager assigned to a user.

Input parameters of the RemoveManager action

For an example about how to configure this action, see Examples.

RetrieveManagerChain action

This action retrieves a manager of a user.

Input parameters of the RetrieveManagerChain action

For an example about how to configure this action, see Examples.

AddProfileCardProperty action

This action adds a new ProfileCardProperty for an organization.

Input parameters of the AddProfileCardProperty action

For an example about how to configure this action, see Examples.

RemoveProfileCardProperty action

This action removes a ProfileCardProperty for an organization.

Input parameters of the RemoveProfileCardProperty action

For an example about how to configure this action, see Examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - AddGroupMember

1. In the Configure connector task dialog, click Actions.
2. Select the AddGroupMember action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
     "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
     }
     

This action returns confirmation message of the AddGroupMember If the action is successful, the AddGroupMember task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - RemoveGroupMember

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveGroupMember action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
     "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
     }
     

If the action is successful, the RemoveGroupMember task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - AddGroupMember(Guest Account)

1. In the Configure connector task dialog, click Actions.
2. Select the AddGroupMember action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
     "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
     }
     

If the action is successful, the AddGroupMember task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - RemoveGroupMember(Guest Account)

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveGroupMember action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
     "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
     }
     

If the action is successful, the RemoveGroupMember task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - AddUserApplicationRoleAssignment

1. In the Configure connector task dialog, click Actions.
2. Select the AddUserApplicationRoleAssignment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
     "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e",
     "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217"
     }
     

If the action is successful, the AddUserApplicationRoleAssignment task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - RemoveUserApplicationRoleAssignment

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveUserApplicationRoleAssignment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
     "AppRoleAssignmentId": "bspYNS4s00GoVL-SSaPJE0xC2--0GxxIu8uS4aeindU"
     }
     

If the action is successful, the RemoveUserApplicationRoleAssignment task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - AddGroupApplicationRoleAssignment

1. In the Configure connector task dialog, click Actions.
2. Select the AddGroupApplicationRoleAssignment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e",
     "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217",
     "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
     }
     

If the action is successful, the AddGroupApplicationRoleAssignment task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - RemoveGroupApplicationRoleAssignment

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveGroupApplicationRoleAssignment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
     "AppRoleAssignmentId": "p3luD3g1tEid3t7Pu3uxAMT7DwI3p29HlrxMuZ143eU"
     }
     

If the action is successful, the RemoveGroupApplicationRoleAssignment task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - ActivateDirectoryRole

1. In the Configure connector task dialog, click Actions.
2. Select the ActivateDirectoryRole action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

    {
     "RoleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033"
     } 
     

If the action is successful, the ActivateDirectoryRole task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "id": "c865d9cb-57da-416c-97a3-753e733da678",
  "roleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033",
  "displayName": "Service Support Administrator",
  "description": "Can read service health information and manage support tickets."
  }]
  

Example - VerifyDomain

1. In the Configure connector task dialog, click Actions.
2. Select the VerifyDomain action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Id": "eternalsolarsolutions.com"
     } 
     

If the action is successful, the VerifyDomain task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - ChangePassword

1. In the Configure connector task dialog, click Actions.
2. Select the ChangePassword action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "NewPassword": "XXX@9876",
     "CurrentPassword": "XXX@123"
     }
     

If the action is successful, the ChangePassword task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - ResetPassword

1. In the Configure connector task dialog, click Actions.
2. Select the ResetPassword action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "Password": "XXX@9876",
     "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
     }
     

If the action is successful, the ResetPassword task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - AssignLicense

1. In the Configure connector task dialog, click Actions.
2. Select the AssignLicense action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
     "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com",
     "AddLicenseSkuId": "6ec92958-3cc1-49db-95bd-bc6b3798df71"
     }
     

If the action is successful, the AssignLicense task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - RemoveLicense

1. In the Configure connector task dialog, click Actions.
2. Select the AssignLicense action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
     "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com",
     "RemoveLicenses": "6ec92958-3cc1-49db-95bd-bc6b3798df71"
     }
     

If the action is successful, the RemoveLicense task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - FetchAdditionalUserFields

1. In the Configure connector task dialog, click Actions.
2. Select the FetchAdditionalUserFields action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
     } 
     

If the action is successful, the FetchAdditionalUserFields task's connectorOutputPayload response parameter has a value similar to the following:

[{
    "id": "9630c9d7-cf15-4406-8d21-598e41a058cc",
    "deleteddatetime": null,
    "accountenabled": "true",
    "agegroup": null,
    "businessphones": "",
    "city": null,
    "companyname": null,
    "consentprovidedforminor": null,
    "country": null,
    "createddatetime": "2024-04-12T10:24:42Z",
    "creationtype": null,
    "department": null,
    "displayname": "Azure_AD_Test",
    "employeehiredate": null,
    "employeeid": null,
    "employeeleavedatetime": null,
    "employeetype": null,
    "externaluserstate": null,
    "externaluserstatechangedatetime": null,
    "faxnumber": null,
    "givenname": null,
    "imaddresses": "",
    "isresourceaccount": null,
    "jobtitle": null,
    "lastpasswordchangedatetime": "2024-05-14T05:07:15Z",
    "legalagegroupclassification": null,
    "mail": null,
    "mailnickname": "Azure_AD_Test",
    "mobilephone": null,
    "officelocation": null,
    "onpremisesdistinguishedname": null,
    "onpremisesdomainname": null,
    "onpremisesimmutableid": null,
    "onpremiseslastsyncdatetime": null,
    "onpremisessamaccountname": null,
    "onpremisessecurityidentifier": null,
    "onpremisessyncenabled": null,
    "onpremisesuserprincipalname": null,
    "othermails": "",
    "passwordpolicies": null,
    "postalcode": null,
    "preferreddatalocation": null,
    "preferredlanguage": null,
    "proxyaddresses": "",
    "securityidentifier": "S-1-12-1-2519779799-1141296917-2388205965-3428360257",
    "showinaddresslist": null,
    "signinsessionsvalidfromdatetime": "2024-05-14T05:07:15Z",
    "state": null,
    "streetaddress": null,
    "surname": null,
    "usagelocation": "IN",
    "userprincipalname": "Azure_AD_Test@z8474.onmicrosoft.com",
    "usertype": "Member",
    "aboutme": null,
    "birthday": "0001-01-01T08:00:00Z",
    "hiredate": "0001-01-01T08:00:00Z",
    "interests": "",
    "mysite": null,
    "pastprojects": "",
    "preferredname": "",
    "responsibilities": "",
    "schools": "",
    "skills": "",
    "assignedlicenses": "",
    "assignedplans": "[\r\n  {\r\n    \"assignedDateTime\": \"2024-05-16T10:17:45Z\",\r\n    \"capabilityStatus\": \"Deleted\",\r\n    \"service\": \"DynamicsNAV\",\r\n    \"servicePlanId\": \"3f2afeed-6fb5-4bf9-998f-f2912133aead\"\r\n  }\r\n]",
  "authorizationinfo_certificateuserids": "",
  "identities": "[\r\n  {\r\n    \"signInType\": \"userPrincipalName\",\r\n    \"issuer\": \"z8474.onmicrosoft.com\",\r\n    \"issuerAssignedId\": \"Azure_AD_Test@z8474.onmicrosoft.com\"\r\n  }\r\n]",
  "licenseassignmentstates": "",
  "onpremisesextensionattributes_extensionattribute1": null,
  "onpremisesextensionattributes_extensionattribute2": null,
  "onpremisesextensionattributes_extensionattribute3": null,
  "onpremisesextensionattributes_extensionattribute4": null,
  "onpremisesextensionattributes_extensionattribute5": null,
  "onpremisesextensionattributes_extensionattribute6": null,
  "onpremisesextensionattributes_extensionattribute7": null,
  "onpremisesextensionattributes_extensionattribute8": null,
  "onpremisesextensionattributes_extensionattribute9": null,
  "onpremisesextensionattributes_extensionattribute10": null,
  "onpremisesextensionattributes_extensionattribute11": null,
  "onpremisesextensionattributes_extensionattribute12": null,
  "onpremisesextensionattributes_extensionattribute13": null,
  "onpremisesextensionattributes_extensionattribute14": null,
  "onpremisesextensionattributes_extensionattribute15": null,
  "onpremisesprovisioningerrors": "",
  "provisionedplans": "",
  "serviceprovisioningerrors": "",
  "customsecurityattributes": "{\r\n  \"ConnectorTesting\": {\r\n    \"@odata.type\": \"#microsoft.graph.customSecurityAttributeValue\",\r\n    \"FavouriteSport\": \"cricket\",\r\n    \"FavouriteMovie\": \"3 idiots\"\r\n  }\r\n}",
  "signinactivity_lastsignindatetime": "2024-05-14T07:04:51Z",
  "signinactivity_lastsigninrequestid": "ed35b322-d0d9-4fcb-8e71-f9ee7e065e00",
  "signinactivity_lastnoninteractivesignindatetime": "2024-05-15T09:00:02Z",
  "signinactivity_lastnoninteractivesigninrequestid": "0d4ce88b-710a-440f-a612-f590954d6800",
  "signinactivity_lastsuccessfulsignindatetime": "2024-05-15T06:45:42Z",
  "signinactivity_lastsuccessfulsigninrequestid": "64643e9d-3468-4e4d-b7c3-8bd316956600"
  }  
  

Example - AddGroupOwner

1. In the Configure connector task dialog, click Actions.
2. Select the AddGroupOwner action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
     "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
     }
     

f the action is successful, the AddGroupOwner task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - RemoveGroupOwner

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveGroupOwner action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
     "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
     }
     

If the action is successful, the RemoveGroupOwner task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - InviteExternalUser

1. In the Configure connector task dialog, click Actions.
2. Select the InviteExternalUser action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserEmailAddress": "taleprajyot97@gmail.com",
     "RedirectURL": "https://www.example.com"
     }
     

This action returns confirmation message of the InviteExternalUser If the action is successful, the InviteExternalUser task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True",
  "Id": "70905aef-361f-4cb1-8d04-41f9e377ebd3",
  "ReedemURL": "https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3d9b25e811-f983-4982-82e4-263c1ca48112%26user%3d70905aef-361f-4cb1-8d04-41f9e377ebd3%26ticket%3dx5aOZc%25252bE9XslKcOdb101qLnoe2V%25252b8%25252beeFlNhYA5WvTg%25253d%26ver%3d2.0",
  "InvitedUserId": "d5eeb199-a544-4985-b726-e3073751050c"
  }]
  

Example - AddPhoneAuthenticationMethod

1. In the Configure connector task dialog, click Actions.
2. Select the AddPhoneAuthenticationMethod action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "PhoneType": "mobile",
     "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81",
     "PhoneNumber": "+91 9898989890"
     }
     

If the action is successful, the AddPhoneAuthenticationMethod task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - RemovePhoneAuthenticationMethod

1. In the Configure connector task dialog, click Actions.
2. Select the RemovePhoneAuthenticationMethod action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "PhoneType": "mobile",
     "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81",
     "PhoneNumber": "+91 9898989890"
     }
     

If the action is successful, the RemovePhoneAuthenticationMethod task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - UpdatePhoneAuthenticationMethod

1. In the Configure connector task dialog, click Actions.
2. Select the UpdatePhoneAuthenticationMethod action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "securityComplianceNotificationPhones": "9899999999",
     "securityComplianceNotificationMails": "abc@gmail.com"
     }
     

If the action is successful, the UpdatePhoneAuthenticationMethod task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - AddPrivilegedRole

1. In the Configure connector task dialog, click Actions.
2. Select the AddPrivilegedRole action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
     "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
     "Justification": "Add Privileged Role",
     "ScheduleInfo": "{\n\"StartDateTime\" : \"2022-09-09T21:31:27.91Z\",\n\"Expiration\"    : {\n\"Type\"        : \"Eligible\"}\n}"
     }
     

If the action is successful, the AddPrivilegedRole task's connectorOutputPayload response parameter has a value similar to the following:ç

[{
  "Success": "True"
  }]
  

Example - RemovePrivilegedRole

1. In the Configure connector task dialog, click Actions.
2. Select the RemovePrivilegedRole action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
     "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
     "Justification": "Removing Privileage Role"
     }
     

If the action is successful, the RemovePrivilegedRole task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "Success": "True"
  }]
  

Example - RetrieveUserPhoto

1. In the Configure connector task dialog, click Actions.
2. Select the RetrieveUserPhoto action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserId": "8e22c728-c523-436b-8f46-3b21cc1b5f80"
     } 
     

If the action is successful, the RetrieveUserPhoto task's connectorOutputPayload response parameter has a value similar to the following:

[{
    "Status": "Success",
    "FileData": "77+9UE5HDQoaCgAAAA1JSERSAAADUgAAAjYIBgAAAFo077+977+9AAAAAXNSR0IA77+977+9HO+/vQAAAARnQU1BAADvv73vv70L77+9YQUAAAAJcEhZcwAADu+/vQAADu+/vQHvv71v77+9ZAAA77+977+9SURBVHhe77+977+9ZXwcV9K+LWlmZCbvv71O77+977+977+9ZO+/vcmG77+9Ge+/vThmZmZm77+9OO+/vcmG77+977+9MTMzM++/vS0z77+977+977+9eu+/ve+/vXTvv71o77+9KAvvv73vv73vv71w77+9DjRO77+977+9Vl3vv70677+9KWsrR2zvv71zEe+/ve+/vUTvv73vv717KGrvv709EO+/ve+/vWjvv71RG01777+977+9Me+/ve+/vWjvv73vv719OmJLyqfZuu+/vRHvv71ZK++/vQ7Uj9iJ77+977+9du+/vUXEslrvv73vv73vv70uzbzvv70pFu+/vUrvv709Yl4P77+9eu+/vSDvv73vv71n77+977+977+9Gu+/ve+/vV3vv71sP2Vm77+977+9be+/vWbvv707RmxV77+9VFvvv70u77+9Fu+/ve+/vdqi77+9aTbvv71N77+977+9Re+/ve+/vWPvv70tYe+/vRXvv73vv70677+9bu+/vTRbS++/ve+/ve+/vWxkP1vvv71FbWt377+977+9LdW277+977+977+977+977+9ae+/ve+/vXvvv73vv73vv70Z77+9Xe+/vSLvv73vv70X77+977+9E++/vT1ob1/vv71+ae+/ve+/vWx3by1P77+9XT3vv71sL++/ve+/ve+/vWbvv73vv73vv71m77+9F+e0s2vvv712dErvv73vv73vv73vv73vv73vv71p77+977+9Le+/vW/vv73vv71oZ0vvv73vv70577+9R3tb77+92b7vv70R77+977+9KmIHKQ/vv73vv73agdapdu+/vU3vv73vv73vv73vv73vv71zXe+/ve+/ve+/ve+/ve+/vRTvv70777+977+977+96pqK77+9LO+/vXN077+9PO+/ve+/ve+/vVp2f++/vdOgNO+/ve+/veyBlO+/ve+/vQdQ77+9cO+/vTc477+9bBDvv71S77+977+977+977+9Zu+/ve+/vW8I77+977+977+9ZQ8paFnvv70LWnxwYe+/ve+/vVEWNBvvv71O77+977+9eQMKW++/vV8x77+977+9FO+/vd6k77+977+9LmHvv70eRS3erQBiG++/vXXvv71DzLI577+9LO+/vT3vv73vv71077+9Ze+/ve+/ve+/vTcebe+/vWbvv73vv71E77+9UEPvv71r77+9NMus77+9Zu+/ve+/vUVsXe+/ve+/ve+/ve+/ve+/vWZr77+9c29qRG0177+9VdWi77+977+9eu+/ve+/ve+/vUlfTe+/ve+/vW/vv73NujVTbX3vv73vv73vv73vv70V77+9He+/ve+/vXUj77+977+9AdeeMe+/ve+/ve+/ve+/ve+/ve+/vQHvv73vv70Y77+9aFcj77+9Y2Pvv700Zjtpb2vvv73vv73vv73vv73ZmHvXnHvvv70Y77+904Lvv73vv70y77+977+9EO+/ve+/vRjvv73vv71077+9dDvbs++/ve+/vXsX4bqU77+9Wu+/vVsH77+977+977+977+9P1vvv73vv70y77+9fO+/ve+/vV8pZd6rJe+/vXvvv70cy6Yef++/ve+/vWXvv71U1LJf77+9Wg3vv73vv71j1otF77+9NO+/ve+/vQTvv73vv70A77+9SO+/vWZHD++/vQ3vv71ta++/ve+/ve+/veO+rmDvv73vv73vv71c77+9cD1+77+9Hu+/ve+/vSpG77+977+9Y++/ve+/vWfvv73vv73vv70zMXvvv73vv73vv73
  ...[too long to view on UI. Please use the API to view the full content.]
  

Example - UpdateUserPhoto

1. In the Configure connector task dialog, click Actions.
2. Select the UpdateUserPhoto action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc",
     "Content": "iVBORw0KGgoAAAANSUhEUgAAA1IAAAI2CAIAAADVVi6oAAAgAElEQVR4AZy9d3Rc1dX3r3POHVmWrG6ckIQHN0gCCYEkT/IkJA89lARc1Xsf1ZlR78W2iis4BFuybMAFMMW4qctFknu31XvvzTbu0tx9fmufOzMWJe+b97fWXmede2ekBYs/8sm3bJm1uLAry9jJt2jFq9Khl6XDL0vFr0ilr0pHXlMdf52ee5tdXU5b3diAN50IYHdCyYMINh1FIJpCnJmcRCGFQSqBdDNIJzhp5H4Su5FIx5PYYDzrjaVdcaxRS+qjyWWNdFlHL2jZBR27ECNdiqNX41l9HG1MYI0JtCWBtSTSjiTWnSz1pNCuZNKXKvWl0e4U0p/GhtLZcDodz2QjmWw0i42soiOZdDiDDaXToVQ6ms76k2lvEuuKZ71xbCBJ6o+nA7F0IIb260ifhg5p6EAkHdGycS0bjaJjGjYWxSY17IZOmtCQ61p6P0a6HU1vRtPbsfRePH2QQO8lkXtJdDqN4aRTfRbRryaQQ+Ucqs+mshj9GiqvocpLyKU8h0CueMwmPJtCDoE8CtlMn2cxnWsh51pCnrWca8FzzSHPAtZYyqusIdMG0s15hq2cOkdOniUnW8hxVI5V6WPpdDSd1kn3IsndKPZNOL2hZteD6HgAHfSnff6s1ZM1u9NmD9biKTW500Z3qdGDNnmxFi+pyYO2+7BWL9Lmy9q8WbuP1OHHegJZVwDr8qc9gawvkPYF0cEgOhTMhkPYcKhqIIj2BpP+IDoQQkfD2WgEG4mgY5EqPCPodS27FUfvJ5lPpVnJGVaQbS9n28o5c+V1j+rXzYWN8+RN9vCuLWyep99kL2901G+Yo19rAevw33p6vdX9XPM72Wwiiw2l0v5U1p9Ge1Kk1gRaH8dOR7Ayf/alh2qnk7RjhWrbUmnLO6p332DrX6fZr0iZL7KUF1jCn1TaP86K/P2siN9Zhj43R/1b68DfWPv+ysbrlw5uT9g6L7JducjeeZGjy6J5zo/buyxwdF9g77nIwfcJ+9Bfzo34pX3MMw4Jv7LP/K3tpj/b5L9gu/0Fq89fn130zpzyFXNOONuecZ1z0WtOnd+ctiDrjkCbwTDH4Qjrm9qf3on9yd34H02n/Jc+9TFIf1xOX6hPexwyF0Da49NJj00nPXYndt7tuB9N6hyGImx71datfrOueNHTrtKR5axkmVS2fHaN67wLvovq1c+26f7cl/zqZPbye5u99NuC4JMI2B8LFelwIodffg/qtkBzIbTthI5dvHMP7/4cp+dL3vcVH9jPBw/CUDEfKYPRMj5Wzscq+dgRPirOh5dK8VH5d04YKYVR8YOj5TBSir9kpIwPlcJwKQyXwHAJFwNDxfg4VGx6lAcP8YGHA/0H8bH/EO8Tl76DeOk7CP378Z+wfx/v3wf9+6Dva7kXT+jbB31fQe9X0P0V79mH0/0V71LmS979BXR9bjp59xe86wve+Tl07OWdnxtnL+/cCx2fKcM7PoP2T6H9Uy5OaPuEt38C7Z/wtj3Qsou37sZp2cNb9sgte3gzDjTv4U27efNO3vwxb/4Ip0lM807etBMaP4KGHdCwgzd+iO8bP+SNH0KT4aXhfcN2qC/k9dvlum1Qvw3qxGPdNj5joN74WFsw8z3eDW8KeJ34qLYA3xhHrsuH+nxel89r83ndVsPP1hZA7VbAx628Lh8atvLGfF6/Va4v4LVbceryeaPxfWM+NObzhgLegC+VAeXeUIAX/KgA3xu/gL+wYSv+lGmMH+GbpgLT4HdmPP7f780FvHnrw2nZyvHNNpyWfN4i7k3boLmAt4pp2cZbC7npbNnGWwrxo5Z8aM0X39kGbQWG6djK2/OhrYC35z+cjnxow/e8Ix/E8M4C6MjnnQUPp2sb79qGj8rZOeOufPS9E7rF
     ...[too long to view on UI. Please use the API to view the full content.]
     

If the action is successful, the UpdateUserPhoto task's connectorOutputPayload response parameter has a value similar to the following:

 [{
  "Status": "Success"
  }]
  

Example - RemoveUserPhoto

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveUserPhoto action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

    {
     "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
     } 
     

If the action is successful, the RemoveUserPhoto task's connectorOutputPayload response parameter has a value similar to the following:

 [{
  "Status": "Success"
  }]
  

Example - AssignManager

1. In the Configure connector task dialog, click Actions.
2. Select the AssignManager action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
     "ObjectId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
     "ObjectName": "users"
     }
     

If the action is successful, the AssignManager task's connectorOutputPayload response parameter has a value similar to the following:

 [{
  "Status": "True"
  }]
  

Example - RemoveManager

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveManager action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
     } 
     

If the action is successful, the RemoveManager task's connectorOutputPayload response parameter has a value similar to the following:

 [{
  "Status": "True"
  }]
  

Example - RetrieveManagerChain

1. In the Configure connector task dialog, click Actions.
2. Select the RetrieveManagerChain action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "UserId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
     "Levels": "max"
     }
     

If the action is successful, the RetrieveManagerChain task's connectorOutputPayload response parameter has a value similar to the following:

[{
  "id": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
  "displayName": "test1",
  "manager": "{\r\n  \"@odata.type\": \"#microsoft.graph.user\",\r\n  \"id\": \"9630c9d7-cf15-4406-8d21-598e41a058cc\",\r\n  \"deletedDateTime\": null,\r\n  \"accountEnabled\": true,\r\n  \"ageGroup\": null,\r\n  \"businessPhones\": [],\r\n  \"city\": null,\r\n  \"companyName\": null,\r\n  \"consentProvidedForMinor\": null,\r\n  \"country\": null,\r\n  \"createdDateTime\": \"2024-04-12T10:24:42Z\",\r\n  \"creationType\": null,\r\n  \"department\": null,\r\n  \"displayName\": \"Azure_AD_Test\",\r\n  \"employeeId\": null,\r\n  \"employeeHireDate\": null,\r\n  \"employeeLeaveDateTime\": null,\r\n  \"employeeType\": null,\r\n  \"externalUserState\": null,\r\n  \"externalUserStateChangeDateTime\": null,\r\n  \"faxNumber\": null,\r\n  \"givenName\": null,\r\n  \"isLicenseReconciliationNeeded\": false,\r\n  \"jobTitle\": null,\r\n  \"legalAgeGroupClassification\": null,\r\n  \"mail\": null,\r\n  \"mailNickname\": \"Azure_AD_Test\",\r\n  \"mobilePhone\": null,\r\n  \"onPremisesDistinguishedName\": null,\r\n  \"onPremisesDomainName\": null,\r\n  \"onPremisesImmutableId\": null,\r\n  \"onPremisesLastSyncDateTime\": null,\r\n  \"onPremisesSecurityIdentifier\": null,\r\n  \"onPremisesSamAccountName\": null,\r\n  \"onPremisesSyncEnabled\": null,\r\n  \"onPremisesUserPrincipalName\": null,\r\n  \"otherMails\": [],\r\n  \"passwordPolicies\": null,\r\n  \"officeLocation\": null,\r\n  \"postalCode\": null,\r\n  \"preferredDataLocation\": null,\r\n  \"preferredLanguage\": null,\r\n  \"proxyAddresses\": [],\r\n  \"refreshTokensValidFromDateTime\": \"2024-05-14T05:07:15Z\",\r\n  \"imAddresses\": [],\r\n  \"isResourceAccount\": null,\r\n  \"showInAddressList\": null,\r\n  \"securityIdentifier\": \"S-1-12-1-2519779799-1141296917-2388205965-3428360257\",\r\n  \"signInSessionsValidFromDateTime\": \"2024-05-14T05:07:15Z\",\r\n  \"state\": null,\r\n  \"streetAddress\": null,\r\n  \"surname\": null,\r\n  \"usageLocat
  ...[too long to view on UI. Please use the API to view the full content.]
  

Example - AddProfileCardProperty

1. In the Configure connector task dialog, click Actions.
2. Select the AddProfileCardProperty action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

    {
   "Annotations": "[{"displayName": "Attributes"}]",
   "DirectoryPropertyName": "CustomAttribute15"
   }

If the action is successful, the AddProfileCardProperty task's connectorOutputPayload response parameter has a value similar to the following:

 [{
"Status": "True"
}]

Example - RemoveProfileCardProperty

1. In the Configure connector task dialog, click Actions.
2. Select the RemoveProfileCardProperty action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "DirectoryPropertyName": "CustomAttribute12"
   } 

If the action is successful, the RemoveProfileCardProperty task's connectorOutputPayload response parameter has a value similar to the following:

 [{
"Status": "True"
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List the groups

1. In the Configure connector task dialog, click Entities.
2. Select Groups from the Entity list.
3. Select the LIST operation, and then click Done.
4. Task Input section of the Connectors task, you can set the filterClause as per the customer requirement.

You must use single quotes (') to enclose the value for filter clause. You can use the filter clause to filter records based on the columns.

You can also perform LIST operations on the following entities:

• User
• GroupMembers
• Domains
• RoleAssignments
• Applications
• Devices
• Contacts
• DirectoryRoleTemplates
• DirectoryRoles
• AdministrativeUnits
• SubscribedSKUs
• PhoneAuthenticationMethod
• Organization
• DeviceLocalCredentials
• ProfileCardProperties

Example - Get a single record from the group

1. In the Configure connector task dialog, click Entities.
2. Select Groups from the Entity list.
3. Select the GET operation, and then click Done.
4. Set the entity ID to "bb4756c7-38c0-426b-97aa-03b6443e7f16" which is the Key to be passed. To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "bb4756c7-38c0-426b-97aa-03b6443e7f16" in the Input Value field and choose the EntityId as Local variable.

You can also perform GET operations on the following entities:

• User
• GroupMembers
• Domains
• RoleAssignments
• Applications
• Devices
• Contacts
• DirectoryRoleTemplates
• DirectoryRoles
• AdministrativeUnits
• PhoneAuthenticationMethod
• Organization
• UserManagers
• DeviceLocalCredentials

Example - Delete a record from the group

1. In the Configure connector task dialog, click Entities.
2. Select Groups from the Entity list.
3. Select the DELETE operation, and then click Done.
4. Set the entity ID to "62008bbe-effa-4341-9d29-eac7f67b84fe", which is the key to be passed. To set the entity ID, in the Data Mapper section of the Data Mapping, click Open Data Mapping Editor and then enter "62008bbe-effa-4341-9d29-eac7f67b84fe" in the Input Value field and choose the EntityId as Local variable.

   If two composite or primary keys are present, then passing a Entity Id might throw an error. In such cases, you can use the filter clause, such as, id='62008bbe-effa-4341-9d29-eac7f67b84fe'.

You can also perform DELETE operations on the following entities:

Example - Create a group (Microsoft 365) entity

1. In the Configure connector task dialog, click Entities.
2. Select Groups from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload as Local variable.

   {
   "securityEnabled": true,
   "displayName": "GoogleGCP",
   "description": "This Group is creating for gcp testing.",
   "mailEnabled": false,
   "mailNickname": "GoogleGCP",
   "groupTypes": "Unified"
   }

   This example creates the Groups records. If the integration is successful, the Groups task's connectorOutputPayload response parameter has a value similar to the following:

   {
   "id": "30fc13b3-79b3-4ac5-a3ba-684d4e887ecc"
   } 

Example - Update a user

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Data Mapper section of the Data Mapping task, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as Local variable.

   {
   "jobTitle": "Software Engineer"
   }

5. Set the entity ID in Data Mapper to the entity of the Users. To set the entity ID, click Open Data Mapping Editor and then enter a value similar to the following in the Input Value field and choose the EntityId/ConnectorInputPayload/FilterClause as a local variable.

   Alternately, instead of specifying the entityId, you can also set the filterClause to 7ad59ec3-1c37-4932-be51-7513fe98c3c3.

   This example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
   "id": "7ad59ec3-1c37-4932-be51-7513fe98c3c3"
   }