Google 會運用 AI 技術將內容翻譯成你偏好的語言，但可能會出錯。

REST Resource: customers.v2.Users

資源：使用者

使用者的 SCIM 表示法。

JSON 表示法

JSON 表示法
{ "schemas": [ string ], "emails": [ { object (`Email`) } ], "addresses": [ { object (`Address`) } ], "phoneNumbers": [ { object (`Phone`) } ], "groups": [ { object (`GroupReference`) } ], "id": string, "externalId": string, "meta": { object (`Meta`) }, "userName": string, "name": { object (`Name`) }, "displayName": string, "active": boolean, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { object (`EnterpriseUserExtension`) }, "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser": { object (`CloudIdentityUserExtension`) } }

{
  "schemas": [
    string
  ],
  "emails": [
    {
      object (Email)
    }
  ],
  "addresses": [
    {
      object (Address)
    }
  ],
  "phoneNumbers": [
    {
      object (Phone)
    }
  ],
  "groups": [
    {
      object (GroupReference)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "userName": string,
  "name": {
    object (Name)
  },
  "displayName": string,
  "active": boolean,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    object (EnterpriseUserExtension)
  },
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser": {
    object (CloudIdentityUserExtension)
  }
}

欄位
`schemas[]`	`string` 這是必要旗標，URI 清單，指出 SCIM 結構定義的命名空間，這些結構定義定義了目前 JSON 結構中的屬性。只能包含為使用者 ResourceType 定義為 `schema` 和 `schemaExtensions` 的值。
`emails[]`	`object (Email)` 選用。使用者的電子郵件地址清單。資料大小上限為 10 KB。系統會自動將與 `userName` 對應的電子郵件地址新增至這份清單，並將其 `primary` 子屬性設為 `true`。這個主要電子郵件項目為唯讀，無法透過這項屬性修改。
`addresses[]`	`object (Address)` 選用。使用者的實際地址清單。資料大小上限為 10 KB。
`phoneNumbers[]`	`object (Phone)` 選用。使用者的電話號碼清單。資料大小上限為 1 KB。
`groups[]`	`object (GroupReference)` 僅供輸出。使用者直接加入的群組清單，最多顯示 1, 000 個群組。根據預設，系統不會傳回這項屬性，必須使用 `attributes` 查詢參數要求。客戶必須加入許可清單，才能讀取這項屬性。請與支援團隊聯絡，說明您的用途並要求存取權。
`id`	`string` ID。使用者的專屬 ID。屬性特徵為 `caseExact` (`true`)、可變動性為 `readOnly`，以及 `returned` 特徵為 `always`。
`externalId`	`string` 選用。SCIM 使用者的用戶端定義 ID。這個欄位須區分大小寫，且可變更。伺服器不會強制要求不重複，因此用戶端必須確保不重複。
`meta`	`object (Meta)` 僅供輸出。包含資源中繼資料的複雜屬性。所有 `meta` 子屬性都是由服務供應商指派 (`mutability` 為 `readOnly`)，且所有這些子屬性的 `returned` 特徵都是 `default`。如果用戶端提供這項屬性，系統會忽略。
`userName`	`string` 這是必要旗標，使用者的主要電子郵件地址。做為使用者的專屬 ID。
`name`	`object (Name)` 這是必要旗標，使用者姓名。
`displayName`	`string` 選用。使用者的顯示名稱。長度上限：256 個半形字元。
`active`	`boolean` 選用。使用者的帳戶狀態 (`false` 表示帳戶已停權)。預設值：`true`。
`urn:ietf:params:scim:schemas:extension:enterprise:2.0:User`	`object (EnterpriseUserExtension)` 選用。SCIM Enterprise 企業版使用者擴充功能屬性。
`urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser`	`object (CloudIdentityUserExtension)` 選用。SCIM Cloud Identity 使用者擴充功能屬性。

名稱

使用者名稱的 SCIM 表示法。

JSON 表示法
{ "familyName": string, "givenName": string }

欄位

欄位
`familyName`	`string` 這是必要旗標，使用者的姓氏。
`givenName`	`string` 這是必要旗標，使用者的名字。

familyName

string

這是必要旗標，使用者的姓氏。

givenName

string

這是必要旗標，使用者的名字。

電子郵件

使用者電子郵件的 SCIM 表示法。

JSON 表示法
{ "value": string, "type": string, "primary": boolean }

欄位

欄位
`value`	`string` 這是必要旗標，使用者的電子郵件地址。
`type`	`string` 電子郵件帳戶的類型。有效值為 `home`、`work` 和 `other`。
`primary`	`boolean` 僅供輸出。指出這是否為使用者的主要電子郵件地址。只有對應 `userName` 的電子郵件，這個值才會設為 `true`。

value

string

這是必要旗標，使用者的電子郵件地址。

type

string

電子郵件帳戶的類型。有效值為 home、work 和 other。

primary

boolean

僅供輸出。指出這是否為使用者的主要電子郵件地址。只有對應 userName 的電子郵件，這個值才會設為 true。

地址

使用者地址的 SCIM 表示法。

JSON 表示法
{ "formatted": string, "streetAddress": string, "locality": string, "region": string, "postalCode": string, "country": string, "type": string, "primary": boolean }

欄位
`formatted`	`string` 完整地址，格式化後顯示。
`streetAddress`	`string` 街道地址。
`locality`	`string` 城市或縣市。
`region`	`string` 區域或州/省。
`postalCode`	`string` 郵遞區號。
`country`	`string` 國家/地區。
`type`	`string` 地址類型，有效值為 `home`、`work` 和 `other`。
`primary`	`boolean` 指出這是否為使用者的主要地址。

電話

使用者電話號碼的 SCIM 表示法。

JSON 表示法
{ "value": string, "type": string, "primary": boolean }

欄位

欄位
`value`	`string` 這是必要旗標，電話號碼。
`type`	`string` 電話號碼類型，有效值為 `home`、`work`、`mobile`、`fax`、`pager` 和 `other`。
`primary`	`boolean` 指出這是否為使用者的主要電話號碼。

value

string

這是必要旗標，電話號碼。

type

string

電話號碼類型，有效值為 home、work、mobile、fax、pager 和 other。

primary

boolean

指出這是否為使用者的主要電話號碼。

EnterpriseUserExtension

定義 SCIM 企業版使用者擴充功能的屬性。這項擴充功能的結構定義 URN 為：urn:ietf:params:scim:schemas:extension:enterprise:2.0:User。詳情請參閱 RFC 7643 第 4.3 節。

JSON 表示法
{ "employeeNumber": string, "costCenter": string, "organization": string, "department": string, "manager": { object (`Manager`) } }

欄位
`employeeNumber`	`string` 選用。通常由機構指派的 ID，用於識別機構內的使用者。
`costCenter`	`string` 選用。使用者支出所屬成本中心的 ID。
`organization`	`string` 選用。使用者所屬組織的名稱。
`department`	`string` 選用。使用者所屬部門的名稱，格式為文字。
`manager`	`object (Manager)` 選用。使用者的主管。複雜屬性，可讓服務供應商視需要參照其他使用者的 `id` 屬性，藉此表示組織階層。

管理員

使用者主管的 SCIM 表示法。欄位依據 RFC 7643 第 4.3 節。

JSON 表示法
{ "value": string, "$ref": string }

欄位

欄位
`value`	`string` 選用。代表使用者主管的 SCIM 資源 `id`。
`$ref`	`string` 僅供輸出。代表使用者主管的 SCIM 資源 URI。

value

string

選用。代表使用者主管的 SCIM 資源 id。

$ref

string

僅供輸出。代表使用者主管的 SCIM 資源 URI。

GroupReference

使用者群組成員資格的 SCIM 表示法。

JSON 表示法
{ "value": string, "$ref": string, "type": string }

欄位

欄位
`value`	`string` 僅供輸出。代表群組的 SCIM 資源 `id`。
`$ref`	`string` 僅供輸出。代表群組的 SCIM 資源 URI。
`type`	`string` 僅供輸出。群組成員資格類型。有效值為 `direct` 和 `indirect`。

value

string

僅供輸出。代表群組的 SCIM 資源 id。

$ref

string

僅供輸出。代表群組的 SCIM 資源 URI。

type

string

僅供輸出。群組成員資格類型。有效值為 direct 和 indirect。

CloudIdentityUserExtension

定義 Google Cloud Identity 使用者擴充功能的屬性。這個擴充功能的結構定義 URN 為：urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser。

JSON 表示法

JSON 表示法
{ "websites": [ { object (`Website`) } ], "additionalExternalIds": [ { object (`ExternalId`) } ], "additionalIms": [ { object (`AdditionalIm`) } ], "additionalOrganizations": [ { object (`AdditionalOrganization`) } ], "addressListVisible": boolean, "gender": string, "organizationalUnit": { object (`OrganizationalUnit`) }, "primaryOrganization": { object (`PrimaryOrganization`) } }

{
  "websites": [
    {
      object (Website)
    }
  ],
  "additionalExternalIds": [
    {
      object (ExternalId)
    }
  ],
  "additionalIms": [
    {
      object (AdditionalIm)
    }
  ],
  "additionalOrganizations": [
    {
      object (AdditionalOrganization)
    }
  ],
  "addressListVisible": boolean,
  "gender": string,
  "organizationalUnit": {
    object (OrganizationalUnit)
  },
  "primaryOrganization": {
    object (PrimaryOrganization)
  }
}

欄位
`websites[]`	`object (Website)` 選用。與使用者相關聯的網站，不含 `profile` 類型的網站 (對應至 SCIM 核心架構屬性 `profileUrl`)。
`additionalExternalIds[]`	`object (ExternalId)` 選用。使用者的外部 ID 集合。這份清單是 SCIM 核心結構定義屬性 `externalId` 和 SCIM 企業版使用者擴充功能屬性 `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber` 已代表的屬性補充組合。
`additionalIms[]`	`object (AdditionalIm)` 選用。使用者的非主要即時通訊地址。排除主要即時訊息地址，對應至 SCIM 核心結構定義屬性 `ims`。
`additionalOrganizations[]`	`object (AdditionalOrganization)` 選用。使用者的非主要機構。
`addressListVisible`	`boolean` 選用。指出是否要在全域通訊清單中顯示使用者。如果用戶端未指派或清除這項屬性，則預設為 `true`。
`gender`	`string` 選用。使用者的性別。支援的值為 `female`、`male`、`other` 和 `unknown`。系統也支援自訂值，任何其他字串值都會視為自訂性別。
`organizationalUnit`	`object (OrganizationalUnit)` 選用。使用者的組織單位。
`primaryOrganization`	`object (PrimaryOrganization)` 選用。使用者主要機構的其他屬性。排除 `name`、`department` 和 `costCenter` (以 `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` 表示)，以及 `title` (對應至 SCIM 核心結構定義屬性 `title`)。

OrganizationalUnit

使用者組織單位的 SCIM 表示法。

JSON 表示法
{ "path": string }

欄位

欄位
`path`	`string` 選用。使用者所屬組織單位的完整路徑 (例如 `/corp/engineering`)，或頂層組織單位的 `/`。組織單位必須已存在。如果用戶端未指派或清除這項屬性，則預設為 `/`。

path

string

選用。使用者所屬組織單位的完整路徑 (例如 /corp/engineering)，或頂層組織單位的 /。組織單位必須已存在。如果用戶端未指派或清除這項屬性，則預設為 /。

網站

使用者網站的 SCIM 表示法。排除類型為 profile 的網站，對應至 SCIM 核心結構定義屬性 profileUrl。

JSON 表示法
{ "value": string, "type": string }

欄位

欄位
`value`	`string` 這是必要旗標，網站網址。
`type`	`string` 選用。網站類型。支援的值為 `home`、`work` 和 `other`。`home` 或 `work` 以外的任何輸入值都會視為 `other`。

value

string

這是必要旗標，網站網址。

type

string

選用。網站類型。支援的值為 home、work 和 other。home 或 work 以外的任何輸入值都會視為 other。

ExternalId

使用者額外外部 ID 的 SCIM 表示法。不含 SCIM 核心架構屬性 externalId 和 SCIM 企業版使用者擴充屬性 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber 已代表的外部 ID。

JSON 表示法
{ "value": string, "type": string }

欄位

欄位
`value`	`string` 這是必要旗標，外部 ID 的值。
`type`	`string` 選用。外部 ID 的類型。支援的值包括 `account`、`customer`、`loginId` 和 `network`。系統也支援自訂值，任何其他字串值都會視為自訂類型。`organization` 和 `cloudidentityscim.googleapis.com` 是保留值，無法使用。

value

string

這是必要旗標，外部 ID 的值。

type

string

選用。外部 ID 的類型。支援的值包括 account、customer、loginId 和 network。系統也支援自訂值，任何其他字串值都會視為自訂類型。organization 和 cloudidentityscim.googleapis.com 是保留值，無法使用。

AdditionalIm

使用者非主要即時訊息 (IM) 位址的 SCIM 表示法。排除主要即時訊息地址，對應至 SCIM 核心結構定義屬性 ims。

JSON 表示法
{ "value": string, "usage": string, "type": string }

欄位

欄位
`value`	`string` 這是必要旗標，即時訊息位址。
`usage`	`string` 選用。IM 的用途。支援的值包括 `home`、`work` 和 `other`。系統也支援自訂值，任何其他字串值都會視為自訂用途。
`type`	`string` 選用。IM 服務的類型。支援的值包括 `aim`、`gtalk`、`icq`、`jabber`、`msn`、`netmeeting`、`qq`、`skype` 和 `yahoo`。系統也支援自訂值，任何其他字串值都會視為自訂類型。

value

string

這是必要旗標，即時訊息位址。

usage

string

選用。IM 的用途。支援的值包括 home、work 和 other。系統也支援自訂值，任何其他字串值都會視為自訂用途。

type

string

選用。IM 服務的類型。支援的值包括 aim、gtalk、icq、jabber、msn、netmeeting、qq、skype 和 yahoo。系統也支援自訂值，任何其他字串值都會視為自訂類型。

PrimaryOrganization

使用者主要機構的 SCIM 表示法。這個複雜屬性中的欄位適用於與 SCIM 企業版使用者擴充功能 (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User) 相同的主要機構。不包含 name、department 和 costCenter (由 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 中的 organization、department 和 costCenter 屬性表示)，以及 title (對應至 SCIM 核心結構定義屬性 title)。

JSON 表示法
{ "type": string, "domain": string, "fullTimeEquivalent": integer, "location": string, "symbol": string }

欄位
`type`	`string` 選用。機構類型。有效值為 `school` 和 `work`。
`domain`	`string` 選用。與組織相關聯的網域名稱。例如 `example.com`。
`fullTimeEquivalent`	`integer` 選用。組織內的全職等效千分比 (100000 = 100%)。
`location`	`string` 選用。機構的實際位置。
`symbol`	`string` 選用。機構的符號。

AdditionalOrganization

使用者非主要機構的 SCIM 表示法。排除使用者的主要機構，該機構會顯示在 primaryOrganization 屬性、SCIM 企業版使用者擴充功能 (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User) 和 SCIM 核心結構定義屬性 title 中。

JSON 表示法
{ "type": string, "costCenter": string, "department": string, "domain": string, "fullTimeEquivalent": integer, "location": string, "name": string, "symbol": string, "title": string }

欄位
`type`	`string` 選用。機構類型。有效值為 `school` 和 `work`。
`costCenter`	`string` 選用。組織的成本中心。
`department`	`string` 選用。組織部門。
`domain`	`string` 選用。與組織相關聯的網域名稱。例如 `example.com`。
`fullTimeEquivalent`	`integer` 選用。組織內的全職等效千分比 (100000 = 100%)。
`location`	`string` 選用。機構的實際位置。
`name`	`string` 選用。組織名稱。
`symbol`	`string` 選用。機構的符號。
`title`	`string` 選用。使用者在機構中的職稱。

方法
`create`	建立使用者。
`delete`	刪除使用者。
`get`	擷取使用者。
`list`	擷取使用者清單。
`patch`	使用 SCIM 修補語意更新使用者。

REST Resource: customers.v2.Users

資源：使用者

名稱

電子郵件

地址

電話

EnterpriseUserExtension

管理員

GroupReference

CloudIdentityUserExtension

OrganizationalUnit

網站

ExternalId

AdditionalIm

PrimaryOrganization

AdditionalOrganization

方法

`create`

`delete`

`get`

`list`

`patch`

REST Resource: customers.v2.Users 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

資源：使用者

名稱

電子郵件

地址

電話

EnterpriseUserExtension

管理員

GroupReference

CloudIdentityUserExtension

OrganizationalUnit

網站

ExternalId

AdditionalIm

PrimaryOrganization

AdditionalOrganization

方法

create

delete

get

list

patch

REST Resource: customers.v2.Users

`create`

`delete`

`get`

`list`

`patch`