REST Resource: customers.v2.Groups

リソース: Group

グループの SCIM 表現。

JSON 表現 
{
  "schemas": [
    string
  ],
  "members": [
    {
      object (Member)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "displayName": string,
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup": {
    object (CloudIdentityGroupExtension)
  }
}
フィールド
schemas[]

string

必須。現在の JSON 構造に存在する属性を定義する SCIM スキーマの名前空間を示す URI のリスト。Group ResourceType に対して schema と schemaExtensions として定義された値のみを含める必要があります。
members[]

object (Member)

省略可。このグループのメンバーのリスト。現在、この属性は返されません。グループ メンバーシップは PATCH リクエストで変更できます。
id

string

ID。グループの一意の ID。属性の特性は、caseExact が true、変更可能性が readOnly、returned 特性が always です。
externalId

string

省略可。プロビジョニング クライアントによって定義されたリソースの識別子。
meta

object (Meta)

出力専用。リソース メタデータ。すべてのサブ属性の変更可能性は readOnly で、returned 特性は default です。
displayName

string

必須。グループの表示名。
urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup

object (CloudIdentityGroupExtension)

必須。Cloud Identity 固有のグループ属性。

メンバー

グループ メンバーの SCIM 表現。

JSON 表現 
{
  "value": string,
  "$ref": string
}
フィールド
value

string

変更不可。このグループのメンバーの識別子。
$ref

string

変更不可。メンバーの URI。

CloudIdentityGroupExtension

Google Cloud Identity Group 拡張機能の属性を定義します。この拡張機能のスキーマ URN は urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup です。

JSON 表現 
{
  "email": string,
  "description": string
}
フィールド
email

string

必須。グループのメールアドレス。アカウントに複数のドメインがある場合は、メールアドレスに適したドメインを選択します。email は一意である必要があります。グループのメールアドレスには、ユーザー名と同じ文字使用ルールが適用されます。詳しくは、ヘルプセンターのドキュメントをご覧ください。
description

string

省略可。ユーザーが Group の目的を判断するのに役立つ詳細な説明。

上限: 4,096 文字。

メソッド

create

 グループを作成します。

delete

 グループを削除します。

get

 グループを取得します。

list

 グループのリストを取得します。

patch

 SCIM パッチ セマンティクスを使用してグループを更新します。