For the complete documentation index, see llms.txt. This page is also available as Markdown.

チームメンバー

チームへのユーザーの追加・削除、チーム内の役割の設定、チームメンバーの一覧を API で行えます。チーム自体の作成やシナリオの割り当ては「チーム」をご覧ください。

コード例の BASE_URL・headers・API_KEY は、「認証」のコード例で定義したものです。

エンドポイント一覧

メソッド
エンドポイント
内容

DELETE

/teams/{teamID}/users/{userID}

PUT

/teams/{teamID}/users/{userID}/role

GET

/teams/{teamID}/users/page/{page}/limit/{limit}

すべてのエンドポイントは、APIキーが無効な場合に 401(ボディは error キー)、レート制限を超えた場合に 429 を返します。詳しくは「認証」「レート制限」をご覧ください。


チームにユーザーを追加する

1人以上のユーザーをチームに追加します。

POST /teams/{teamID}/users

パスパラメーター

パラメーター
型
説明

teamID

string(UUID)

チーム ID

リクエストボディ

フィールド
型
説明
必須

user_ids

string[](UUID)

チームに追加するユーザー ID の一覧

はい

ユーザー ID は、組織にユーザーを追加するのレスポンスの results[].id、または組織のユーザーを一覧するで取得できます。

レスポンス

ステータス
内容

204 No Content

チームへの追加に成功。ボディはありません

400

不正なリクエスト

401

APIキーが無効

429

レート制限を超えた

例


チームからユーザーを外す

ユーザーを1人、チームから外します。

パスパラメーター

パラメーター
型
説明

teamID

string(UUID)

チーム ID

userID

string(UUID)

チームから外すユーザーの ID

レスポンス

ステータス
内容

204 No Content

チームから外すことに成功。ボディはありません

401

APIキーが無効

404

見つからない

429

レート制限を超えた

例


チーム内の役割を設定する

チーム内でのユーザーの役割を設定します。役割は member(通常のメンバー。既定値)または manager(チームマネージャー)です。チームマネージャーには、チームメンバーのアナリティクスを閲覧できるなど、追加の権限があります。

ここで設定するのはチーム内の役割です。組織のロール(MANAGER など)とは別のものです。組織のロールはユーザーにロールを割り当てるで設定します。

パスパラメーター

パラメーター
型
説明

teamID

string(UUID)

チーム ID

userID

string(UUID)

ユーザー ID

リクエストボディ

フィールド
型
説明
必須

role

string

設定する役割。member または manager

はい

レスポンス

204 No Content: 役割の更新に成功しました。

エラー

コード
説明

400

不正なリクエスト(役割の値が無い・正しくない、JSON ボディの形式が正しくない、teamID・userID が UUID でない)

401

APIキーが無効

429

レート制限を超えた

500

ユーザーがチームのメンバーではない

先にユーザーをチームに追加してください。 まだチームに所属していないユーザーに役割を設定すると、500 とボディ {"message": "unable to updates a requested team"} が返ります。チームにユーザーを追加するで追加してから、役割を設定してください。ユーザーを追加しないまま同じリクエストを繰り返しても、同じレスポンスが返ります。

例


チームメンバーを一覧する

チームのユーザーをページ単位で取得します。

パスパラメーター

パラメーター
型
説明

teamID

string(UUID)

チーム ID

page

integer

ページ番号(1から始まる)

limit

integer

1ページあたりの件数(1〜100)

クエリパラメーター

パラメーター
型
説明

search

string

検索語でメンバーを絞り込む

user_roles

string

組織のロールで絞り込む(カンマ区切り。例: USER,MANAGER)

user_status

string

状態で絞り込む(カンマ区切り)。値は active、inactive、invited、expired(例: active,inactive)。このエンドポイントは状態として expired を返さないため、expired での絞り込みは使わないでください

レスポンス

200 OK

フィールド
型
説明

users[].id

string(UUID)

ユーザー ID

users[].email

string

メールアドレス

users[].name

string または null

表示名。まだ名前を設定していないユーザーは null

users[].roles

string[]

組織で割り当てられたロール

users[].organization_roles

null

このエンドポイントでは null が返ります。roles を読んでください

users[].status

string

active、inactive、invited のいずれか

users[].team_role

string

このチーム内での役割。member(通常のメンバー)または manager(チームマネージャー)。チームメンバーの一覧のレスポンスにだけ含まれます

records

integer

条件に一致したメンバーの総数

このエンドポイントが返す状態について メンバーの状態は保存されている値のまま返されるため、有効期限を過ぎた招待も invited と表示されます。組織のユーザーを一覧するでは、同じメンバーが expired と表示されます。有効期限切れを状態に反映させたい場合は、そちらのエンドポイントを使ってください。

ステータス
内容

200

成功

401

APIキーが無効

429

レート制限を超えた

例

最終更新