REST Resource: customers.v2.Groups

資源:群組

群組的 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

這是必要旗標,URI 清單,指出定義目前 JSON 結構中屬性的 SCIM 結構定義命名空間。只能包含為群組 ResourceType 定義的 schema 和 schemaExtensions 值。

members[]

object (Member)

選用。這個群組的成員清單。目前不會傳回這項屬性。您可以使用 PATCH 要求修改群組成員資格。

id

string

ID。群組的專屬 ID。屬性特徵為 caseExact (true)、readOnly 的可變動性,以及 always 的 returned 特徵。

externalId

string

選用。資源的 ID,由佈建用戶端定義。

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

不可變動。這個群組成員的 ID。

$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 修補程式語意更新群組。