List members

GET

/api/v1/members

GET

/api/v1/members

curl https://alephant.io/api/v1/members \
     -H "Authorization: Authorization" \
     -H "X-Workspace-Id: X-Workspace-Id"

{
  "data": [
    {
      "createdAt": "string",
      "departmentId": "string",
      "email": "string",
      "id": "string",
      "keyExpiresAt": "string",
      "keyExpiryPreset": "string",
      "masterKeyId": "string",
      "monthlyBudget": 1.1,
      "name": "string",
      "note": "string",
      "projectId": "string",
      "projectName": "string",
      "requests": 1,
      "roleLabel": "string",
      "spend": 1.1,
      "status": "string",
      "tokens": 1,
      "virtualKey": "string",
      "virtualKeyId": "string",
      "virtualKeyStatus": "string"
    }
  ],
  "meta": {
    "overview": {
      "activeCount": 1,
      "totalMonthlyBudgetCents": 1,
      "totalPeriodRequests": 1,
      "totalPeriodSpendCents": 1,
      "totalPeriodSpendUsd": 1.1,
      "totalPeriodTokens": 1,
      "withVirtualKeyCount": 1
    },
    "page": 1,
    "pageSize": 1,
    "total": 1,
    "totalPages": 1
  }
}

List members with usage from v_member_usage. Owner, admin, viewer. Member role cannot list. projectId and unassigned are mutually exclusive. When Collector analytics is configured, spend and requests on each row and overview totals are merged from GET /v1/analytics/saas/costs-by-entities with entityType=member and current-page member ids.

查询参数

pageinteger可选默认为 1

Page number

pageSizeinteger可选默认为 20

Items per page

statusstring可选

active, revoked, suspended

departmentIdstring可选

Department UUID

projectIdstring可选格式: "uuid"

Project UUID (mutually exclusive with unassigned)

unassignedboolean可选

Only members without a project (mutually exclusive with projectId)

searchstring可选

Search name/email

响应

datalist of objects可选

metaobject可选

错误

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

请求头

查询参数

响应

错误