List all users

Lists all the users from all the organizations in a Frontier instance. It can be filtered by keyword, organization, group and state.

Query Parameters

page_size int32

The maximum number of users to return per page. The default is 50.

page_num int32

The page number to return. The default is 1.

keyword string

The keyword to search for. It can be a user's name, email,metadata or id.

org_id string

The organization id to filter by.

group_id string

The group id to filter by.

state string

The state to filter by. It can be enabled or disabled.

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

count int32
users object[]
Array [
id string
name can either be empty or must start with a character
Unique name of the user.
title string
Name of the user.
email string
metadata object
created_at date-time
The time the user was created.
updated_at date-time
The time the user was last updated.
state string
The state of the user (enabled or disabled).
avatar string
The base64 encoded image string of the user avatar. Should be less than 2MB.
]

{
  "count": 0,
  "users": [
    {
      "id": "string",
      "name": "johndoe",
      "title": "John Doe",
      "email": "string",
      "metadata": {},
      "created_at": "2023-06-07T05:39:56.961Z",
      "updated_at": "2023-06-07T05:39:56.961Z",
      "state": "enabled",
      "avatar": "string"
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

GET /v1beta1/admin/users

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL

http://127.0.0.1:7400

Security Scheme

BasicBearer

Username

Password

page_size — query

page_num — query

keyword — query

org_id — query

group_id — query

state — query

curl / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/admin/users' \
-H 'Accept: application/json'