List users
const url = 'https://gateway.staging.arago-tech.com/auth/users';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://gateway.staging.arago-tech.com/auth/usersList users with optional search, sortable by first_name, last_name, updated_at
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters”Query
Search query to filter users by firstname or lastname
Tags
List of tags to filter users by
Statuses
List of statuses to filter users by
Roles
Roles to filter users by
From Date
Filter items with date on or after this timestamp
To Date
Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.
From Date
Filter items with date on or after this timestamp
To Date
Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.
From Date
Filter items with date on or after this timestamp
To Date
Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.
Disable
A flag indicating if the user is disable or not
Field
The field to sort by. This should be a valid field name in the context of the request.
Desc
The sort order. If true, the results will be sorted in descending order. If false, the results will be sorted in ascending order.
Offset
The offset of the first item
Limit
The maximum number of items to return (must be >= 10 and <= 1000)
Responses
Section titled “ Responses ”A successful response.
Response containing a list of users.
object
List of users
Represent User authentification information.
object
User ID
Email of the user to fetch
First name of the user
Last name of the user
Tags of the user
Roles of the user
Indicates whether the user is disabled
Status of the user. Possible values are: STATUS_ACTIVE, STATUS_PENDING_INVITATION, STATUS_SUSPENDED
Created At of the user
Updated At of the user
Last Connection of the user
Effective permissions granted by the roles of the user, named after the RPC method they authorize. Only populated by GetUser.
Indicates if the response is from a full text search (true) or a database list (false)
Example
{ "users": [ { "email": "6L5lR@example.com", "id": "63e2d42a27ad5f2b345ca123" } ], "full_text_search": true}Bad request
object
Example
{ "error": { "code": "BAD_REQUEST", "details": [ { "code": "PATTERN", "field": "username", "message": "does not match regex pattern `^[a-zA-Z]*$`" }, { "code": "MIN_LEN", "field": "username", "message": "must be at least 3 characters", "params": { "min": "3" } } ], "message": "Bad request" }}Unauthorized
object
Example
{ "error": { "code": "UNAUTHORIZED", "message": "Unauthorized" }}Forbidden
object
Example
{ "error": { "code": "FORBIDDEN", "message": "Forbidden" }}Not found
object
Example
{ "error": { "code": "NOT_FOUND", "message": "Not found" }}Internal server error
object
Example
{ "error": { "code": "INTERNAL", "details": [ { "code": "INTERNAL", "field": "line_items[0]", "message": "Couldn't upsert line item" }, { "code": "INTERNAL", "field": "line_items[380]", "message": "Couldn't upsert line item" } ], "message": "Internal server error" }}Gateway timeout
object
Example
{ "error": { "code": "TIMEOUT", "details": [ { "code": "TIMEOUT", "field": "request", "message": "Request processing time exceeded deadline", "params": { "duration": "30s" } } ], "message": "Gateway timeout" }}default
Section titled “default”An unexpected error response.
object
Any contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
In its binary encoding, an Any is an ordinary message; but in other wire
forms like JSON, it has a special encoding. The format of the type URL is
described on the type_url field.
Protobuf APIs provide utilities to interact with Any values:
- A ‘pack’ operation accepts a message and constructs a generic
Anywrapper around it. - An ‘unpack’ operation reads the content of an
Anymessage, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declaredtype_url. - An ‘is’ operation decides whether an
Anycontains a message of the given type, i.e. whether it can ‘unpack’ that type.
The JSON format representation of an Any follows one of these cases:
- For types without special-cased JSON encodings, the JSON format
representation of the
Anyis the same as that of the message, with an additional@typefield which contains the type URL. - For types with special-cased JSON encodings (typically called ‘well-known’
types, listed in https://protobuf.dev/programming-guides/json/#any), the
JSON format representation has a key
@typewhich contains the type URL and a keyvaluewhich contains the JSON-serialized value.
The text format representation of an Any is like a message with one field
whose name is the type URL in brackets. For example, an Any containing a
foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.
object
Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name.
Example: type.googleapis.com/google.protobuf.StringValue
This string must contain at least one / character, and the content after
the last / must be the fully-qualified name of the type in canonical
form, without a leading dot. Do not write a scheme on these URI references
so that clients do not attempt to contact them.
The prefix is arbitrary and Protobuf implementations are expected to
simply strip off everything up to and including the last / to identify
the type. type.googleapis.com/ is a common default prefix that some
legacy implementations require. This prefix does not indicate the origin of
the type, and URIs containing it are not expected to respond to any
requests.
All type URL strings must be legal URI references with the additional
restriction (for the text format) that the content of the reference
must consist only of alphanumeric characters, percent-encoded escapes, and
characters in the following set (not including the outer backticks):
/-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations
should not unescape them to prevent confusion with existing parsers. For
example, type.googleapis.com%2FFoo should be rejected.
In the original design of Any, the possibility of launching a type
resolution service at these type URLs was considered but Protobuf never
implemented one and considers contacting these URLs to be problematic and
a potential security issue. Do not attempt to contact type URLs.
Examplegenerated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}