すべてのユーザーグループを取得
リクエスト
GET <REST API URL>/usergroups?fields=string&$skip=int&$top=int&query=string&orderBy=stringパラメーター | 説明 |
|---|---|
fields | オプション。各ユーザーグループのフィールドの指定されたサブセットのみを返します。フィールド構文を使用してサブセットを定義します。 |
$skip | オプション。最初のユーザーグループを返す前にスキップするユーザーグループの数を設定できます。 |
$top | オプション。返すユーザーグループの最大数を設定できます。 |
query | オプション。検索クエリを指定して、返された結果をフィルタリングできます。サポートされている論理演算構文の定義については、照会の構文を参照してください。UserGroups の場合、次のフィールドとタプルがサポートされています。 access (project : project , with : role） — 特定のプロジェクトで特定のロールを持つグループ access (project : project , with : permission） — 指定されたプロジェクトで指定された権限を持つグループ access (project : project） — 特定のプロジェクトで何らかのロールを持つグループ access (organization : organization , with : role） — 指定された組織で指定されたロールが割り当てられているグループ access (organization : organization , with : permission） — 指定された組織で指定された権限が付与されているグループ access (organization : organization） — 指定された組織で任意のロールが割り当てられているグループ access (with : role） — 特定のロールがどこかに割り当てられているグループ access (with : permission） — 指定された権限がどこにでも付与されているグループ has : ownRole — 独自のロールを持つグループ has : user — ユーザーとのグループ has : subgroup — サブグループを持つグループ has : icon — アイコン付きのグループ id : value — 指定された ID のグループ is : allUsers — すべてのユーザーグループ is : registeredUsers — 登録ユーザーグループ is : autoJoin — 自動参加が有効になっているグループ is : required2FA — 必要な二要素認証を使用するグループ name : groupName — 名のグループ ownRole : role — 独自のロールとして特定のロールを持つグループ parent : group — 特定のグループのサブグループ project : project — 特定のプロジェクトのグループ subgroup : group — 指定されたグループをサブグループとして含むグループ team : team — 特定のプロジェクトチームに含まれるグループ user : user — 特定のユーザーをすぐに含むグループ |
orderBy | オプション。指定されたフィールドでソートされたユーザーグループのリストを返します。詳細については、ソート構文を参照してください。ユーザーグループは、次のフィールドによる順序付けをサポートしています: name |
レスポンス
レスポンスコード | 意味 |
|---|---|
200 OK | リクエストが成功しました。 |
400 不正な要求 | リクエストパラメーターの少なくとも 1 つが無効です。例: 渡された JSON オブジェクトの必須フィールドがありません。詳細については、応答のエラーメッセージを確認してください。 |
403 禁止します | 要求元は、要求されたリソースにアクセスできません。 |
404 お探しのページが見つかりませんでした | 要求されたリソースが見つかりませんでした。 |
500 内部サーバーエラー | サーバーエラーのため、リクエストの処理に失敗しました。詳細については、応答のエラーメッセージを確認してください。 |
レスポンスボディ
{
"skip": int,
"top": int,
"total": int,
"usergroups": [userGroup, ...]
}
