CIPP icon

CIPP

Interact with CIPP API

Actions129

Overview

This node operation disables or enables a user account in a tenant environment. It is useful for administrators who need to manage user access by toggling account status, for example, disabling a user who no longer requires access or enabling a previously disabled user. Practical applications include managing employee access during onboarding or offboarding processes.

Use Case Examples

  1. Disabling a user account by providing the user ID and tenant filter, setting 'Account Enabled' to false.
  2. Enabling a user account by providing the user ID and tenant filter, setting 'Account Enabled' to true.

Properties

Name Meaning
User ID The user ID or email address of the user to be disabled or enabled.
Tenant Filter The tenant ID or domain name to specify the tenant context for the user operation.
Account Enabled Boolean flag to enable (true) or disable (false) the user account.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings to control the API request behavior.

Output

JSON

  • userId - The ID or email of the user whose account was enabled or disabled.
  • tenantFilter - The tenant ID or domain name where the user account resides.
  • accountEnabled - The resulting status of the user account after the operation (enabled or disabled).
  • status - The response status indicating success or failure of the disable/enable operation.

Dependencies

  • An API key credential for authenticating with the tenant's user management API.

Troubleshooting

  • Ensure the User ID and Tenant Filter are correctly specified; incorrect values will cause the operation to fail.
  • If the API request times out, consider increasing the timeout setting in Request Options.
  • If SSL certificate validation fails, enabling 'Ignore SSL Issues' may help but use with caution due to security risks.
  • Proxy settings must be correctly configured if a proxy is required for network access.

Discussion