Users: List

Description

List all available Users.

HTTP Request

GET /api/v1beta0/global/users/

Parameters

This endpoint does not take any parameters.

Request body

Do not supply a body with this request.

Successful Response (Status 200)

A list of UserSummary objects.

The API replies with a UserSummaryListResponse object. Example response body:

{
  "data": [
    {
      "email": "string",
      "fullname": "string",
      "id": 1,
      "status": "active",
      "username": "string"
    }
  ],
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "meta": {
    "sample": "string"
  },
  "pagination": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  },
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Other Response Messages

HTTP Status Code Reason Response Model
400

A client-side error was made.

An ApiErrorResponse object
401

The request was not authenticated.

An ApiErrorResponse object
403

Insufficient permissions.

An ApiErrorResponse object
404

Resource not found.

An ApiErrorResponse object
409

Conflict with current state.

An ApiErrorResponse object
422

This request was well-formed but was rejected due to semantic errors.

An ApiErrorResponse object
500

A server-side error occurred.

An ApiErrorResponse object
501

This feature is not implemented in Scalr.

An ApiErrorResponse object
503

The service is currently unavailable.

An ApiErrorResponse object

Try it out!

No parameters.

Filter the results

Filter Value Description
Add a filter on: