Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In this article

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

...

Snap type:

Write

...

Description:

...

Overview

You can use this Snap to add or removes a given user to/from a given role.

Image Removed

...

Snap Type

Manage Role Membership is a Write-type Snap.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Task Pipelines.

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

  • Min: 0

  • Max: 1

  • Mapper

User Object ID, Operation to be performed (Add or Remove), and Group Object ID.

...

Output

Document

  • Min: 0

  • Max: 1

  • Any file Formatter followed by File Writer.

HTTP status code 204 if the operation is successful.

...

[None]

...

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.

...

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

...

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Info
  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ( (blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the fieldset.

  • Remove icon ((blue star)): Indicates that you can remove fields from the fieldset.

Field Name

Field Type

Description

Label*

 

Default Value: Manage Role Membership
Example: Manage Role Membership

String

Specify 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

...

*

 

Default Value: N/A
Example: $splitvalue

String/Expression

Specify the User object ID of the user to be added or removed.

 

Operation*

 

Default

...

Operation

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

Default value: Add to Group

Role Object ID

...

Value: Assign to Role
Example: Remove from Role

Dropdown list

Specify the action to be performed. Available options are:

  • Assign to Role

  • Remove from Role

Role object ID*

Default Value: N/A
Example: e5ebf40e-f991-4810-960-8f56e41f2aes

String/Expression

Specify the Role object ID of the destination role.

...


Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Default ValueExecute only
Example: Validate & Execute

Dropdown list

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

Multiexcerpt include macro
nameObtaining User object ID/Role object ID/Group object ID
pageCreate Entry


Multiexcerpt include macro
nameMicrosoft Graph API Output
pageCreate Entry


Insert excerpt
Azure Active Directory Snap Pack
Azure Active Directory Snap Pack
nopaneltrue