CIPP icon

CIPP

Interact with CIPP API

Actions129

Overview

This node operation clears the Immutable ID of a specified user within a tenant. It is useful in scenarios where a user's Immutable ID needs to be reset or removed, such as during user migration or identity synchronization corrections. For example, an administrator can clear the Immutable ID of a user by providing the user's ID or email and the tenant's ID or domain name.

Use Case Examples

  1. Clear the Immutable ID of a user identified by their email address in a specific tenant to resolve synchronization issues.
  2. Reset the Immutable ID for a user in a tenant to prepare for re-assignment or migration.

Properties

Name Meaning
User ID The user ID or email address of the user whose Immutable ID is to be cleared.
Tenant Filter The tenant ID or domain name to specify the tenant context for the operation.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to control the API request behavior.

Output

JSON

  • success - Indicates whether the Immutable ID was successfully cleared.
  • userId - The ID or email of the user whose Immutable ID was cleared.
  • tenant - The tenant ID or domain name where the operation was performed.

Dependencies

  • An API key credential for authenticating with the CIPP API

Troubleshooting

  • Ensure the provided User ID and Tenant Filter are correct and correspond to existing entities in the system.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation errors occur, consider enabling the option to ignore SSL issues, but be aware of security risks.
  • Verify that the API key credential used has sufficient permissions to perform user modifications.

Discussion