Search for users by name or email. The search string is required and must be between 3 and 200 characters. Paging is not supported and it will not return more than 1000 users.
This API will only return metadata for users that are in the same organization as the caller.
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
json
HeaderNotFound
{"error":{"code":"HeaderNotFound","message":"Header Authorization was not found in the request. Access denied."}}
{"error":{"code":"InvalidUsersRequest","message":"Cannot query users.","details":[{"code":"MissingRequiredParameter","message":"A search value was not specified.","target":"$search"},{"code":"InvalidValue","message":"The search value must be between 3 and 200 characters.","target":"$search"}]}}
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.