REST Resource: customers.v2.Users

リソース: User

ユーザーの SCIM 表現。

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) } }

フィールド
schemas[]	string 必須。現在の JSON 構造に存在する属性を定義する SCIM スキーマの名前空間を示す URI のリスト。User 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。属性の特性は、true としての caseExact、readOnly の可変性、always の returned 特性です。
externalId	string 省略可。SCIM ユーザーのクライアント定義識別子。このフィールドでは大文字と小文字が区別され、変更可能です。サーバーは一意性を強制しないため、一意性を確保するのはクライアントの責任です。
meta	object (Meta) 出力専用。リソース メタデータを含む複合属性。すべての meta サブ属性はサービス プロバイダによって割り当てられ（mutability が readOnly）、これらのサブ属性はすべて returned 特性が default です。クライアントから提供された場合、この属性は無視されます。
userName	string 必須。ユーザーのメインのメールアドレス。ユーザーの一意の識別子として使用されます。
name	object (Name) 必須。ユーザーの名前。
displayName	string 省略可。ユーザーの表示名。上限: 256 文字。
active	boolean 省略可。ユーザーのアカウント ステータス（false はアカウントが停止されていることを意味します）。デフォルト: true。
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User	object (EnterpriseUserExtension) 省略可。SCIM Enterprise User 拡張属性。

名前

ユーザー名の SCIM 表現。

JSON 表現
{ "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 に設定されます。

住所

ユーザーの住所の 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 ユーザーのメインの電話番号かどうかを示します。

EnterpriseUserExtension

SCIM Enterprise User 拡張機能の属性を定義します。この拡張機能のスキーマ URN は urn:ietf:params:scim:schemas:extension:enterprise:2.0:User です。詳細については、RFC 7643 セクション 4.3 をご覧ください。

JSON 表現
{ "employeeNumber": string, "costCenter": string, "organization": string, "department": string }

フィールド
employeeNumber	string 省略可。通常は組織によって割り当てられる、組織内のユーザーを識別するために使用される ID。
costCenter	string 省略可。ユーザーの費用が割り当てられるコストセンターの識別子。
organization	string 省略可。ユーザーが所属する組織の名前。
department	string 省略可。部門ユーザーが所属する部門の名前（テキスト形式）。

GroupReference

ユーザーのグループ メンバーシップの SCIM 表現。

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

フィールド
value	string 出力専用。グループを表す SCIM リソースの id。
$ref	string 出力専用。グループを表す SCIM リソースの URI。
type	string 出力専用。グループ メンバーシップのタイプ。有効な値は direct と indirect です。

メソッド
create	ユーザーを作成します。
delete	ユーザーを削除します。
get	ユーザーを取得します。
list	ユーザーのリストを取得します。
patch	SCIM パッチのセマンティクスを使用してユーザーを更新します。