User
Search users
Search users in the organization using their names or emails.
Permissions
This endpoint may be impacted by the following permissions:
- Only users that the authenticated user has the User:GetUserInfo permission for will be returned.
get/v1/{organization}/user/search/
Request
- Base URLhttps://api.amigo.ai
- AuthHTTP bearer and API key in header X-ORG-ID and HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
organizationstring required
Query parameters
querystring required
The search query. Any users whose name or email contains the query are returned.
user_idstring[]
The IDs of the users.
Headers
x-mongo-cluster-namestring nullable
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
Sec-WebSocket-Protocolstring[]
Response
Succeeded.
Changes
No operation changes recorded.