$customHeader
Skip to end of banner
Go to start of banner

Azure Active Directory Manage Role Membership

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

On this Page

Snap type:

Write


Description:

This Snap adds or removes a given user to/from a given role.

  • Expected upstream Snaps: Mapper.
  • Expected downstream Snaps: Any file Formatter followed by File Writer.
  • Expected input: User Object ID, Operation to be performed (Add or Remove), and Group Object ID.
  • Expected output: HTTP status code 204 if the operation is successful.


Prerequisites:

[None]


Support and limitations:Works in Ultra Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Active Directory Basic Auth Account for information on setting up this type of account.


Views:
InputThis Snap has at most one document input view.
OutputThis Snap has at most one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.


User object ID



Required. Object ID of the user to be added or removed.

Default value: [None]


Operation


Required. Action to be performed (Add or Remove).

Default value: Add to Group


Role Object ID


Required. Object ID of the destination role.
Default value: [None]


Snap execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.


Obtaining User object ID/Role object ID/Group object ID from Azure Portal

  1. Log in to the Azure portal.

  2. Navigate to Azure Active Directory>Users/Groups.

  3. Select a specific User/Group.

  4. In the Profile, you can view the Object Id.

  5. Copy the Object ID and use it to configure the relevant Snap as required.


Many features in Microsoft Graph API work similarly to the Azure Active Directory Graph APIs. However, a few have been changed or improved. For instance, there is a variation of the entity names in the output preview. This table depicts the difference in the output:

Old output (Azure AD Graph API)

New Output (Microsoft Graph API)

The entity object Id property was displayed as “ObjectId".

Learn more about the properties in Azure AD Graph API:

Azure AD Graph API Entity and Complex Type Reference

The object Id property is displayed as “Id" in the output.

The output also contains the default parameters shown by the Microsoft Graph API. However, there are certain attributes such as city that can be set by the Create Entry Snap, but this parameter is not displayed in the output as it is not the default output parameter. If you want use such parameters in your output, you can use filters to filter the parameters.

Learn more about the properties in Microsoft Graph API:


Error rendering macro 'excerpt-include' : No link could be created for 'Azure Active Directory Snap Pack'.

  • No labels
$customFooter