グループメンバーシップ
メンバーシップは、ユーザーがグループに属していることを示すために使用されます。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | いいえ | このグループメンバーシップの一意の識別子。 |
type | enum<string> | いいえ | 値は常にgroup_membershipになります。 使用可能なオプション: group_membership. |
user | ユーザー (Mini) | いいえ | メンバーシップが適用されるユーザー。 |
group | グループ (Mini) | いいえ | メンバーシップが適用されるグループ。 |
role | enum<string> | いいえ | グループ内のユーザーのロール。 使用可能なオプション: member, admin. |
created_at | string | いいえ | このメンバーシップが作成された日時。 |
modified_at | string | いいえ | このメンバーシップが最後に変更された日時。 |
例
{
"id": "11446498",
"type": "group_membership",
"user": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"group": {
"id": "11446498",
"type": "group",
"name": "Support",
"group_type": "managed_group"
},
"role": "member",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
グループメンバーシップ
グループメンバーシップのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
total_count | integer | いいえ | コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、total_countよりも少ない場合があります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
offset | integer | いいえ | このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、offsetクエリパラメータと同じになります。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
order | array of object | いいえ | 項目が返される順序。 このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。 |
entries | array of グループメンバーシップ | いいえ | グループメンバーシップのリスト。 |
例
{
"total_count": 5000,
"limit": 1000,
"offset": 2000,
"order": [
{
"by": "type",
"direction": "ASC"
}
],
"entries": [
{
"id": "11446498",
"type": "group_membership",
"user": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"group": {
"id": "11446498",
"type": "group",
"name": "Support",
"group_type": "managed_group"
},
"role": "member",
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
]
}