Update Application User

This endpoint allows you to update specific fields of a user's association with an application. You can modify the user's role within the application, optimization inclusion settings, archive status, license assignments, and application user status.

Supported Fields Table:

FieldTypeDescription / Allowed Values
user_app_rolestringThe role of the user within the application
optimization_inclusionenumOptimization inclusion (include for all optimizations, exclude for all optimizations, exclude for undeprovisioned, exclude for unused)
user_app_archivebooleanWhether the user's association with this application is archived
assign_licensesarrayArray of license IDs to assign to the user for this application (must be valid ObjectIds)
user_app_statusenumApplication user status (active, inactive)

Key Features:

  • Partial Updates: Only include the fields you want to update in the request body
  • Role Management: Update the user's role within the specific application
  • Optimization Control: Exclude users from specific optimization types (undeprovisioned, unused, all, none)
  • Archive Management: Update the user's archive status for the application
  • License Assignment: Assign specific licenses to the user for this application
  • Status Management: Update the user's status for this application

Important Notes:

  • All fields in the request body are optional - only include fields you want to update
  • The optimization_inclusion field controls whether the user is excluded from optimization processes for this specific application
  • The assign_licenses field accepts an array of license IDs to assign to the user for this application (must be valid ObjectIds)
  • The user_app_status field accepts active or inactive as string values
  • Both appId and userId must be valid ObjectIds
  • All validations will be applied during the update process
Language
Credentials
Header
Click Try It! to start a request and see the response here!