Get All Users

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "users": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c23",
      "name": "John Doe",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "license": "Growth",
      "status": 1,
      "isVerified": true,
      "setupCompleted": true,
      "authType": "basic",
      "mfaEnabled": false,
      "customRole": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "custom_role",
        "displayName": "Custom Role"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "lastActive": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

GET

users

Get All Users

curl --request GET \
  --url https://secureai.hiperai.ai/api/external/users \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://secureai.hiperai.ai/api/external/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "users": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c23",
      "name": "John Doe",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "license": "Growth",
      "status": 1,
      "isVerified": true,
      "setupCompleted": true,
      "authType": "basic",
      "mfaEnabled": false,
      "customRole": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "custom_role",
        "displayName": "Custom Role"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "lastActive": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

すべてのユーザーを取得

ページネーションとフィルタリングを使用してすべてのユーザーを取得します。管理者のみがアクセスできます。

エンドポイント

GET /users

説明

このエンドポイントを使用すると、管理者はシステム内のすべてのユーザーのページ分割されたリストを取得できます。役割、ライセンス、ステータス、検索用語などのさまざまな基準によるフィルタリングをサポートします。これは、適切な権限を必要とする管理エンドポイントです。

認証

必須。 API キーを Authorization ヘッダーに含めます。

Authorization: Bearer sk-your-api-key-here

リクエスト

クエリパラメータ

パラメータ	タイプ	必須	デフォルト	説明
`page`	整数	いいえ	1	ページネーションのページ番号
`limit`	整数	いいえ	20	ページあたりのユーザー数 (1 ～ 100)
`search`	文字列	いいえ	-	名前、電子メール、またはユーザー名の検索語
`role`	文字列	いいえ	-	ユーザーロール (管理者、ユーザー、globalReader) によるフィルター
`license`	文字列	いいえ	-	ユーザーライセンスによるフィルター (Essential、Growth、Ultra、Early Access)
`status`	整数	いいえ	-	ユーザーステータスによるフィルター (0=非アクティブ、1=アクティブ)
`sortBy`	文字列	いいえ	作成場所	並べ替えるフィールド
`sortOrder`	文字列	いいえ	説明	ソート順 (昇順、降順)

リクエストの例

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20&role=user&status=1" \
  -H "Authorization: Bearer sk-your-api-key-here"

検索の場合:

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?search=john&license=Growth" \
  -H "Authorization: Bearer sk-your-api-key-here"

応答

成功の応答 (200)

{
  "success": true,
  "users": [
    {
      "id": "60a7c8f5e8b4f5001f7a8c23",
      "name": "John Doe",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "license": "Growth",
      "status": 1,
      "isVerified": true,
      "setupCompleted": true,
      "authType": "basic",
      "mfaEnabled": false,
      "customRole": {
        "id": "60a7c8f5e8b4f5001f7a8c24",
        "name": "custom_role",
        "displayName": "Custom Role"
      },
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "lastActive": "2024-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

応答フィールド

フィールド	タイプ	説明
`success`	ブール値	リクエストが成功した場合は常に `true`
`users`	配列	ユーザーオブジェクトの配列
`users[].id`	文字列	ユーザーの一意の識別子
`users[].name`	文字列	ユーザーのフルネーム
`users[].username`	文字列	ユーザーのユーザー名
`users[].email`	文字列	ユーザーのメールアドレス
`users[].role`	文字列	ユーザーのロール (管理者、ユーザー、globalReader)
`users[].license`	文字列	ユーザーのライセンス層 (Essential、Growth、Ultra、Early Access)
`users[].status`	整数	ユーザーステータス (0=非アクティブ、1=アクティブ)
`users[].isVerified`	ブール値	ユーザーが認証されているかどうか
`users[].setupCompleted`	ブール値	ユーザーセットアップが完了しているかどうか
`users[].authType`	文字列	認証タイプ (基本、auth0)
`users[].mfaEnabled`	ブール値	MFA が有効かどうか
`users[].customRole`	オブジェクト	カスタムロール情報 (割り当てられている場合)
`users[].customRole.id`	文字列	カスタムロールID
`users[].customRole.name`	文字列	カスタムロール名
`users[].customRole.displayName`	文字列	カスタム役割の表示名
`users[].createdAt`	文字列	ユーザー作成のタイムスタンプ
`users[].updatedAt`	文字列	ユーザーの最終更新タイムスタンプ
`users[].lastActive`	文字列	ユーザーの最後のアクティビティのタイムスタンプ
`pagination`	オブジェクト	ページネーション情報
`pagination.page`	整数	現在のページ番号
`pagination.limit`	整数	ページごとの項目
`pagination.total`	整数	ユーザーの総数
`pagination.pages`	整数	総ページ数

使用例

JavaScript

const response = await fetch('https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20', {
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  }
});

const data = await response.json();

if (data.success) {
  console.log(`Showing ${data.users.length} of ${data.pagination.total} users`);
  data.users.forEach(user => {
    console.log(`${user.name} (${user.email}) - ${user.role}`);
  });
}

パイソン

import requests

headers = {
    'Authorization': 'Bearer sk-your-api-key-here'
}

params = {
    'page': 1,
    'limit': 20,
    'role': 'user',
    'status': 1
}

response = requests.get('https://{customer.name}.hiperai.ai/api/external/users', 
                      headers=headers, params=params)
data = response.json()

if data['success']:
    print(f"Showing {len(data['users'])} of {data['pagination']['total']} users")
    for user in data['users']:
        print(f"{user['name']} ({user['email']}) - {user['role']}")

cURL

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?page=1&limit=20" \
  -H "Authorization: Bearer sk-your-api-key-here"

エラー応答

401 不正

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}

403 禁止

{
  "success": false,
  "error": "Access denied",
  "message": "Admin access required"
}

フィルタリングの例

名前またはメールアドレスで検索

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?search=john" \
  -H "Authorization: Bearer sk-your-api-key-here"

役割によるフィルター

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?role=admin" \
  -H "Authorization: Bearer sk-your-api-key-here"

ライセンスによるフィルター

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?license=Growth" \
  -H "Authorization: Bearer sk-your-api-key-here"

ステータスによるフィルター

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?status=1" \
  -H "Authorization: Bearer sk-your-api-key-here"

最終アクティブ順に並べ替え

curl -X GET "https://{customer.name}.hiperai.ai/api/external/users?sortBy=lastActive&sortOrder=desc" \
  -H "Authorization: Bearer sk-your-api-key-here"

使用例

ユーザー管理: システム内のすべてのユーザーを表示および管理します
ユーザー分析: ロール、ライセンス、またはステータスごとにユーザーの分布を分析します。
検索とフィルター: さまざまな条件に基づいて特定のユーザーを検索します
管理タスク: 管理操作とレポート作成をサポートします。

役割の説明

admin: 管理制御による完全なシステムアクセス
ユーザー: チャット機能と個人のナレッジベースへの標準アクセス
globalReader: 表示権限を持つ管理パネルへの読み取り専用アクセス

ライセンスの説明

Essential: 29,000 ポイント/月のベーシックレベル
成長: 機能が強化された中間層
ウルトラ: 最大限の機能を備えたプレミアム層
早期アクセス: 実験的な機能を備えたベータ版

レート制限

このエンドポイントは、標準のレート制限に従います。

1 分あたり 60 リクエスト
1 時間あたり 1000 リクエスト

承認

Authorization

string

header

必須

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

クエリパラメータ

page

integer

デフォルト:1

Page number for pagination

必須範囲: x >= 1

limit

integer

デフォルト:20

Number of users per page

必須範囲: 1 <= x <= 100

string

Search term for name, email, or username

role

enum<string>

Filter by user role

利用可能なオプション:

admin,

user,

globalReader

license

enum<string>

Filter by user license

利用可能なオプション:

Essential,

Growth,

Ultra,

Early Access

status

enum<integer>

Filter by user status (0=inactive, 1=active)

利用可能なオプション:

0,

1

sortBy

string

デフォルト:createdAt

Field to sort by

sortOrder

enum<string>

デフォルト:desc

Sort order

利用可能なオプション:

asc,

desc

レスポンス

List of users

success

boolean

例:

true

users

object[]

Show child attributes

pagination

object

Show child attributes

導入 & セットアップ

モデル & AI 生成

ナレッジベース & RAG

セキュリティ、ガードレール & 監査

ユーザー & アクセス (IAM)

請求、クォータ & Webhook

すべてのユーザーを取得

すべてのユーザーを取得

エンドポイント

説明

認証

リクエスト

クエリパラメータ

リクエストの例

応答

成功の応答 (200)

応答フィールド

使用例

JavaScript

パイソン

cURL

エラー応答

401 不正

403 禁止

フィルタリングの例

名前またはメールアドレスで検索

役割によるフィルター

ライセンスによるフィルター

ステータスによるフィルター

最終アクティブ順に並べ替え

使用例

役割の説明

ライセンスの説明

レート制限

承認

クエリパラメータ

レスポンス

​すべてのユーザーを取得

​エンドポイント

​説明

​認証

​リクエスト

​クエリパラメータ

​リクエストの例

​応答

​成功の応答 (200)

​応答フィールド

​使用例

​JavaScript

​パイソン

​cURL

​エラー応答

​401 不正

​403 禁止

​フィルタリングの例

​名前またはメールアドレスで検索

​役割によるフィルター

​ライセンスによるフィルター

​ステータスによるフィルター

​最終アクティブ順に並べ替え

​使用例

​役割の説明

​ライセンスの説明

​レート制限

承認

クエリパラメータ

レスポンス

すべてのユーザーを取得

エンドポイント

説明

認証

リクエスト

クエリパラメータ

リクエストの例

応答

成功の応答 (200)

応答フィールド

使用例

JavaScript

パイソン

cURL

エラー応答

401 不正

403 禁止

フィルタリングの例

名前またはメールアドレスで検索

役割によるフィルター

ライセンスによるフィルター

ステータスによるフィルター

最終アクティブ順に並べ替え

使用例

役割の説明

ライセンスの説明

レート制限