Login

  • Auth
  • GET Users

List of users

This method allows you to draw up a list of users and their authorized privileges in the reference domain.

Resource

Production environment:

  • https://auth.altravia.com/users/
  • https://auth.altravia.com/users/"username"

Testing environment:

  • https://test.auth.altravia.com/users/
  • https://test.auth.altravia.com/users/"username"

Parameters

Request Example

Request for all users:

Response

Response Format

If successful, the response header HTTP status code will be 200 OK and the request will be answered.

If you try to get a request without authorization, you will receive an error 401 Unauthorized.

Additionally you should also handle the 400 Bad request status. For more info on HTTP status handling see dedicated section in Integration best practices page.

Request Response

Parameter Type Description
success boolean True or false.
data DataResponseDetails Returns an array of "user" objects or NULL in case of failure.
domain string Reference domain of user authorizations.
message string Contains error or success messages.
error int Contains the encoding of the error or NULL if successful.

Data Response Details

Parameter Type Description
id_user string Unique identifier of the user.
username string User login mail.
name string User name.
surname string User surname.
cell string User's phone.
timestamp_creation string User creation date.
timestamp_last_access string Last user login date.
privileges_list array Array of user privileges in relation to the domain.
profile_image string Path to the image associated with the user profile.

Additional examples

Request of a specific user:

Response