/programs/{program_id}/frameworks/{framework_id}/auth/users/{auth_user_id}/roleUpdate auth user role
Updates the role of a user in the OptiTech Auth user directory for the specified framework. The role controls the user's level of access within the OptiTech Auth integration.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/auth/users/$AUTH_USER_ID/role" \
-X PUT \
-H "Authorization: Bearer $OPTITECH_API_KEY"optitech optitech-auth user set-role <user-id> --roles <roles>Parameters
program_idThe OptiTech program ID
framework_idThe OptiTech framework ID
auth_user_idThe OptiTech user ID
Request body
1 required Required: roles.
rolesArray of roles to assign to the user
Response
200Updated the auth user role
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.