Users

Operations related to Users

📄️ Retrieve user details by user ID

Retrieve user with 'id' attribute matching specified value.

📄️ Delete user by ID

delete user with 'id' attribute matching specified value.

📄️ Retrieve users matching specified criteria

Retrieve list of users matching the criteria. Note that this operation might result in a larger-than-expected dataset.operation can potentially be expensive as resulting dataset may be large

📄️ Retrieve user details by username

Lets you use the 'username' attribute to get the details of the associated user; specified value should be an email address.

📄️ Check if the username belongs to an SSO account

Check whether the user with 'username' attribute has SSO configured or has logged in locally specified value should be an email address; response contains the companyId, ssoLogin status and localLogin status

📄️ Update user account type.

Update account type for user with 'id' attribute matching specified value.

📄️ Enable/disable the specified user

Enable/disable the specified user.

📄️ Update if a user must change their password at next login

Update if a user's password should be forced into an expired state for user with 'id' attribute matching specified value.

📄️ Enable/disable local login for user

Enable/disable local login for specified user.

📄️ Update user roles.

Update a user's currently assigned user role to limit or expand permissions. Learn more about [user roles](https://docs.venafi.cloud/CSH_user_roles_defined)