Update Application User

patch

https://api-ext.zluri.com/v2/application/{app_id}/user/{user_id}

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:

Field	Type	Description / Allowed Values
`user_app_role`	string	The role of the user within the application
`optimization_inclusion`	enum	Optimization inclusion (`include for all optimizations`, `exclude for all optimizations`, `exclude for undeprovisioned`, `exclude for unused`)
`user_app_archive`	boolean	Whether the user's association with this application is archived
`assign_licenses`	array	Array of license IDs to assign to the user for this application (must be valid ObjectIds)
`user_app_status`	enum	Application 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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

app_id

string

required

The unique identifier of the application (ObjectId).

user_id

string

required

The unique identifier of the user (ObjectId).

Body Params

Application user update request body. All fields are optional - only include fields you want to update.

user_app_role

string

The role of the user within the application

optimization_inclusion

string

enum

Specifies which optimization types to exclude the user from. Use this field to remove user from these optimization processes:

exclude for undeprovisioned: Exclude from undeprovisioned user optimization
exclude for unused: Exclude from unused user optimization
exclude for all optimizations: Exclude from all optimization types
include for all optimizations: Include in all optimization types (no exclusions)

Allowed:

user_app_archive

boolean

Whether the user's association with this application is archived

assign_licenses

array of strings

Array of license IDs to assign to the user for this application

assign_licenses

user_app_status

string

enum

Application user status (active, inactive)

Allowed:

Headers

api-key

string

required

API key for authentication

Responses

200Application user updated successfully

400Bad request - Invalid input data or validation errors

401Unauthorized - Invalid or missing API key

404Application user association not found

500Internal server error