Manage User API Definition
The Manage User API lets you perform different user and team management activities such as adding, deleting, enabling, disabling, and editing user roles. This capability is useful in scenarios that require dynamic team management.
For example, a company wants to onboard new team members efficiently and this
endpoint lets you streamline the onboarding process by programatically
adding new users, assigning appropriate roles, and setting up access
permissions.
Check out our interactive API Reference that lets you experiment with this REST endpoint to manage users for your Vectara account.
userActionType Object
The userActionType
object contains the user
object, which specifies the
id
, handle
, userStatus
, role
, and other information about the user.
REST Example
Manage User Endpoint Address
Vectara exposes a REST endpoint at the following URL to manage users:https://api.vectara.io/v2/users/:user_id
The API Reference shows the full Manage User REST definition.
gRPC Example
You can find the full Manage User gRPC definition at admin_user.proto.