チームメンバー
チームへのユーザーの追加・削除、チーム内の役割の設定、チームメンバーの一覧を API で行えます。チーム自体の作成やシナリオの割り当ては「チーム」をご覧ください。
コード例の BASE_URL・headers・API_KEY は、「認証」のコード例で定義したものです。
エンドポイント一覧
すべてのエンドポイントは、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(チームマネージャー)です。チームマネージャーには、チームメンバーのアナリティクスを閲覧できるなど、追加の権限があります。
パスパラメーター
teamID
string(UUID)
チーム ID
userID
string(UUID)
ユーザー ID
リクエストボディ
role
string
設定する役割。member または manager
はい
レスポンス
204 No Content: 役割の更新に成功しました。
エラー
400
不正なリクエスト(役割の値が無い・正しくない、JSON ボディの形式が正しくない、teamID・userID が UUID でない)
401
APIキーが無効
429
レート制限を超えた
500
ユーザーがチームのメンバーではない
例
チームメンバーを一覧する
チームのユーザーをページ単位で取得します。
パスパラメーター
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
条件に一致したメンバーの総数
200
成功
401
APIキーが無効
429
レート制限を超えた
例
最終更新
