REST Resource: users

リソース: User

Directory API を使用すると、アカウントのユーザー、ユーザー エイリアス、ユーザーの Google プロフィール写真を作成、管理できます。一般的なタスクの詳細については、ユーザー アカウント デベロッパー ガイドとユーザー エイリアス デベロッパー ガイドをご覧ください。

JSON 表現

{ "id": string, "primaryEmail": string, "password": value, "hashFunction": string, "isAdmin": boolean, "isDelegatedAdmin": boolean, "agreedToTerms": boolean, "suspended": boolean, "changePasswordAtNextLogin": boolean, "ipWhitelisted": boolean, "name": { object (UserName) }, "kind": string, "etag": string, "emails": value, "externalIds": value, "relations": value, "aliases": [ string ], "isMailboxSetup": boolean, "customerId": string, "addresses": value, "organizations": value, "lastLoginTime": string, "phones": value, "suspensionReason": string, "thumbnailPhotoUrl": string, "languages": value, "posixAccounts": value, "creationTime": string, "nonEditableAliases": [ string ], "sshPublicKeys": value, "notes": value, "websites": value, "locations": value, "includeInGlobalAddressList": boolean, "keywords": value, "deletionTime": string, "gender": value, "thumbnailPhotoEtag": string, "ims": value, "customSchemas": value, "isEnrolledIn2Sv": boolean, "isEnforcedIn2Sv": boolean, "archived": boolean, "orgUnitPath": string, "recoveryEmail": string, "recoveryPhone": string }

フィールド
id	string ユーザーの一意の ID。ユーザー id は、ユーザー リクエスト URI の userKey として使用できます。
primaryEmail	string ユーザーのメインのメールアドレス。このプロパティは、ユーザー アカウントを作成するリクエストに必須です。primaryEmail は一意にする必要があります。別のユーザーのエイリアスにすることはできません。
password	value (Value format) ユーザー アカウントのパスワードを保存します。ユーザーアカウントの作成時に、ユーザーのパスワード値が必要です。ユーザーを更新する場合は省略可能ですが、ユーザーがアカウント パスワードを更新する場合にのみ指定する必要があります。パスワード値は、API のレスポンス本文で返されません。 パスワードは ASCII 文字を自由に組み合わせて使用し、8 ～ 100 文字にする必要があります。 password パラメータを 16 進数でエンコードされたハッシュ値として送信し、それに応じて hashFunction を設定することをおすすめします。hashFunction を指定する場合、パスワードは有効なハッシュキーでなければなりません。
hashFunction	string password プロパティのハッシュ形式を保存します。使用できる hashFunction の値は次のとおりです。 MD5 - 単純な 16 進数エンコードされた値を受け入れます。 SHA-1 - 単純な 16 進数エンコードされた値を受け入れます。 crypt - C crypt ライブラリに準拠しています。DES、MD5（ハッシュ プレフィックス $1$）、SHA-256（ハッシュ プレフィックス $5$）、SHA-512（ハッシュ プレフィックス $6$）のハッシュ アルゴリズムをサポートします。 接頭辞の一部としてラウンドを指定する場合は、10,000 以下にする必要があります。
isAdmin	boolean 出力のみ。特権管理者権限を持つユーザーを示します。isAdmin プロパティは、[ユーザーを管理者にする] 操作（makeAdmin メソッド）でのみ編集できます。ユーザーの insert メソッドまたは update メソッドで編集された場合、その編集は API サービスによって無視されます。
isDelegatedAdmin	boolean 出力のみ。ユーザーが代理管理者かどうかを示します。 代理管理者は API でサポートされていますが、ユーザーの作成または削除の取り消し、およびユーザー管理者への操作はできません。これらのリクエストは、API サービスによって無視されます。 管理者のロールと権限は、管理コンソールを使用して割り当てます。
agreedToTerms	boolean 出力のみ。ユーザーが最初のログインを完了し、利用規約に同意した場合、このプロパティは true になります。
suspended	boolean ユーザーが停止されているかどうかを示します。
changePasswordAtNextLogin	boolean ユーザーに次回ログイン時にパスワードの変更を要求するかどうかを示します。この設定は、ユーザーがサードパーティの ID プロバイダ経由でログインする場合は適用されません。
ipWhitelisted	boolean true の場合、ユーザーの IP アドレスは非推奨の IP アドレス allowlist 構成の対象となります。
name	object (UserName) ユーザーの姓と名、および読み取り専用の fullName 値を保持します。givenName と familyName の値の最大文字数は 60 文字です。また、名前の値は Unicode 文字または UTF-8 文字をサポートし、スペース、文字（a ～ z）、数字（0 ～ 9）、ダッシュ（-）、スラッシュ（/）、ピリオド（.）を含めることができます。文字の使用ルールの詳細については、管理ヘルプセンターをご覧ください。このフィールドで使用できる最大データサイズは 1 KB です。
kind	string 出力のみ。API リソースのタイプ。Users リソースの場合、値は admin#directory#user です。
etag	string 出力のみ。リソースの ETag。
emails	value (Value format) ユーザーのメールアドレスのリスト。データサイズは最大で 10 KB です。 フィールド emails[].address string ユーザーのメールアドレス。メール ID としても機能します。この値は、ユーザーのメインのメールアドレスまたはエイリアスになります。 emails[].customType string メールアドレス type が custom の場合、このプロパティにはカスタム値が含まれているため、設定する必要があります。 emails[].primary boolean これがユーザーのプライマリ メールアドレスかどうかを示します。プライマリとしてマークできるエントリは 1 つだけです。 emails[].type string メール アカウントの種類。custom に設定する場合は、customType も設定する必要があります。 有効な値: custom、home、other、work。
externalIds	value (Value format) ユーザーの外部 ID（従業員 ID、ネットワーク ID など）のリスト。指定できるデータサイズは最大 2 KB です。 フィールド externalIds[].customType string 外部 ID type が custom の場合、このプロパティにはカスタム値が含まれているため、設定する必要があります。 externalIds[].type string 外部 ID のタイプ。custom に設定する場合は、customType も設定する必要があります。 有効な値: account、custom、customer、login_id、network、organization。 externalIds[].value string 外部 ID の値。
relations	value (Value format) ユーザーと他のユーザーとの関係のリスト。このフィールドのデータサイズは最大 2 KB です。詳しくは、ユーザー アカウントを管理するをご覧ください。 フィールド relations[].customType string 関係 type が custom の場合、このプロパティにはカスタム値が含まれているため、設定する必要があります。 relations[].type string 関係のタイプ。custom に設定する場合は、customType も設定する必要があります。 使用可能な値: admin_assistant assistant brother child custom domestic_partner dotted_line_manager exec_assistant father friend manager mother parent partner referred_by relative sister spouse relations[].value string ユーザーが関連付けられているユーザーのメールアドレス。
aliases[]	string 出力のみ。ユーザーのエイリアス メールアドレスのリスト。
isMailboxSetup	boolean 出力のみ。ユーザーの Google メールボックスが作成されたかどうかを示します。このプロパティは、ユーザーに Gmail ライセンスが割り当てられている場合にのみ適用できます。
customerId	string 出力のみ。すべてのアカウント ユーザーを取得するためのお客様 ID。 エイリアス my_customer を使用してアカウントの customerId を表すことができます。 販売パートナー管理者は、販売パートナー経由で購入された顧客のアカウントの customerId を使用できます。customerId を取得するには、users.list リクエストの domain パラメータでアカウントのプライマリ ドメインを使用します。
addresses	value (Value format) ユーザーの住所のリスト。データサイズは最大で 10 KB です。 フィールド addresses[].country string 国。 addresses[].countryCode string 国コード。ISO 3166-1 標準を使用します。 addresses[].customType string アドレス type が custom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。 addresses[].extendedAddress string 拡張住所（小地域を含む住所など）の場合。 addresses[].formatted string 構造化されていない完全な住所。これは、構造化された住所フィールドとは同期されません。次の属性が含まれます: 番地、私書箱、市区町村、都道府県、郵便番号、国 / 地域。 addresses[].locality string 住所の市区町村。 addresses[].poBox string 私書箱（存在する場合）。 addresses[].postalCode string 郵便番号（該当する場合）。 addresses[].primary boolean これがユーザーのメインの住所かどうか。アドレスリストには、メインのアドレスを 1 つだけ含めることができます。 addresses[].region string 都道府県の略称。 addresses[].sourceIsStructured boolean ユーザー指定の住所がフォーマット済みかどうかを示します。書式設定された住所は現在サポートされていません。 addresses[].streetAddress string 番地（1600 Amphitheatre Parkway など）。文字列内の空白文字は無視されます。ただし、改行は重要です。 addresses[].type string 住所のタイプ。custom に設定する場合は、customType も設定する必要があります。 有効な値: custom、home、other、work。
organizations	value (Value format) ユーザーが所属する組織のリスト。データサイズは最大で 10 KB です。 フィールド organizations[].costCenter string ユーザーの組織のコストセンター。 organizations[].customType string type の値が custom の場合、このプロパティにはカスタム型が含まれます。 organizations[].department string 組織内の部門を指定します（sales、engineering など）。 organizations[].description string 組織の説明。 organizations[].domain string 組織が属しているドメイン。 organizations[].fullTimeEquivalent integer 組織内のフルタイム相当のミリパーセント（100,000 = 100%）。 organizations[].location string 組織の物理的な場所。完全修飾アドレスである必要はありません。 organizations[].name string 組織の名前。 organizations[].primary boolean これがユーザーのプライマリ組織かどうかを示します。ユーザーの主要組織は 1 つのみ設定できます。 organizations[].symbol string 組織のテキスト文字列シンボル。たとえば、Google のテキスト シンボルは GOOG です。 organizations[].title string 組織内でのユーザーの役職。（member や engineer など）が使用されます。 organizations[].type string 組織のタイプ。 使用できる値: domain_only、school、unknown、work。
lastLoginTime	string 出力のみ。ユーザーが最後にユーザーのアカウントにログインした時刻。値は ISO 8601 の日付と時刻の形式です。時刻は、完全な日付に時、分、秒を加えたもので、YYYY-MM-DDThh:mm:ssTZD の形式で指定します。例: 2010-04-05T17:30:04+01:00
phones	value (Value format) ユーザーの電話番号のリスト。指定できるデータサイズは最大 1 KB です。 フィールド phones[].customType string 電話番号 type が custom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。 phones[].primary boolean true の場合、ユーザーのメインの電話番号です。1 人のユーザーに指定できるメインの電話番号は 1 つのみです。 phones[].type string 電話番号のタイプ。custom に設定する場合は、customType も設定する必要があります。 指定できる値: assistant、callback、car、company_main、custom、grand_central、home、home_fax、isdn、main、mobile、other、other_fax、pager、radio、telex、tty_tdd、work、 、 、work_fax。work_mobilework_pager phones[].value string 人が読める形式の電話番号。電話番号の形式は問いません。
suspensionReason	string 出力のみ。停止時に管理者または Google によってユーザー アカウントが停止された理由がある。このプロパティは、suspended プロパティが true の場合にのみ返されます。
thumbnailPhotoUrl	string 出力のみ。ユーザーのプロフィール写真の URL。URL は一時的なものか、非公開のものがあります。
languages	value (Value format) ユーザーの言語のリスト。指定できるデータサイズは最大 1 KB です。 フィールド languages[].customLanguage string その他の言語。対応する ISO 639 言語コードがない場合は、ユーザーが独自の言語名を指定できます。これが設定されている場合、languageCode は設定できません。 languages[].languageCode string 言語の ISO 639 文字列表現。サポートされているコードの一覧については、言語コードをご覧ください。API では、サポートされている言語以外の有効な言語コードも使用できますが、予期しない動作が発生する可能性があります。無効な値があると SchemaException が発生します。これが設定されている場合、customLanguage は設定できません。 languages[].preference string （省略可）存在する場合、指定された languageCode がユーザーの使用言語であるかどうかを制御します。customLanguage が設定されている場合は設定できません。指定できる値は preferred と not_preferred です。
posixAccounts	value (Value format) ユーザーの POSIX アカウント情報のリスト。 フィールド posixAccounts[].accountId string POSIX アカウント フィールド識別子。 posixAccounts[].gecos string このアカウントの GECOS（ユーザー情報）。 posixAccounts[].gid unsigned long デフォルトのグループ ID。 posixAccounts[].homeDirectory string このアカウントのホーム ディレクトリのパス。 posixAccounts[].operatingSystemType string このアカウントのオペレーティング システムの種類。 使用できる値: linux、unspecified、windows。 posixAccounts[].primary boolean このアカウントが SystemId 内でのユーザーのメイン アカウントである場合。 posixAccounts[].shell string このアカウントのログインシェルへのパス。 posixAccounts[].systemId string アカウントのユーザー名または Uid が適用されるシステム ID。 posixAccounts[].uid unsigned long POSIX 準拠のユーザー ID。 posixAccounts[].username string アカウントのユーザー名。
creationTime	string 出力のみ。ユーザーのアカウントが作成された時刻。値は ISO 8601 の日付と時刻の形式です。時刻は、完全な日付に時、分、秒を加えたもので、YYYY-MM-DDThh:mm:ssTZD の形式で指定します。例: 2010-04-05T17:30:04+01:00
nonEditableAliases[]	string 出力のみ。ユーザーの編集不可のエイリアス メールアドレスのリスト。通常、これらのドメインはアカウントのプライマリ ドメインまたはサブドメインに含まれていません。
sshPublicKeys	value (Value format) SSH 公開鍵のリスト。 フィールド sshPublicKeys[].expirationTimeUsec long 有効期限（エポックからのマイクロ秒単位）。 sshPublicKeys[].fingerprint string SSH 公開鍵の SHA-256 フィンガープリント。（読み取り専用） sshPublicKeys[].key string SSH 公開鍵。
notes	value (Value format) ネストされたオブジェクトとしてのユーザー向けのメモ。 フィールド notes.contentType string メモのコンテンツ タイプ（書式なしテキストまたは HTML）。デフォルトは書式なしテキストです。 使用できる値: text_plain、text_html。 notes.value string メモの内容。
websites	value (Value format) ユーザーのウェブサイトのリスト。 フィールド websites[].customType string ウェブサイト type が custom の場合、このプロパティにはカスタム値が含まれているため、設定する必要があります。 websites[].primary boolean true の場合、ユーザーのメインのウェブサイトです。 websites[].type string ウェブサイトのタイプまたは目的。たとえば、ウェブサイトには home や blog というラベルを付けます。また、エントリに custom タイプを指定することもできます。custom に設定する場合は、customType も設定する必要があります。 有効な値: app_install_page、blog、custom、ftp、home、home_page、other、profile、reservations、resume、work。 websites[].value string ウェブサイトの URL。
locations	value (Value format) ユーザーのビジネス拠点のリスト。データサイズは最大で 10 KB です。 フィールド locations[].area string テキストの場所。これは、その場所を簡潔に説明する目的で特に便利です。（Mountain View, CA や Near Seattle など）が使用されます。 locations[].buildingId string ビルディング ID。 locations[].customType string ロケーション type が custom の場合、このプロパティにはカスタム値が含まれているため、設定する必要があります。 locations[].deskCode string 個々のデスクの場所を表す最も具体的なテキストコード。 locations[].floorName string 階の名前/番号。 locations[].floorSection string 階のセクション。階内のより具体的な場所。たとえば、階がセクション A、B、C に分割されている場合、このフィールドはこれらの値のいずれかを識別します。 locations[].type string ロケーション タイプ。custom に設定する場合は、customType も設定する必要があります。 有効な値: custom、default、desk。
includeInGlobalAddressList	boolean ドメインで連絡先の共有機能が有効になっている場合、ユーザーのプロフィールが Google Workspace のグローバル アドレス一覧に表示されるかどうかを示します。ユーザー プロファイルの除外について詳しくは、管理者向けヘルプセンターをご覧ください。
keywords	value (Value format) ユーザーのキーワードのリスト。指定できるデータサイズは最大 1 KB です。 フィールド keywords[].customType string キーワード type が custom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。 keywords[].type string 各エントリには、そのエントリの標準タイプを示すタイプを指定できます。 たとえば、キーワードのタイプは occupation や outlook になります。標準のタイプに加えて、エントリには custom タイプを含めることができ、任意の名前を付けることができます。custom に設定する場合は、customType も設定する必要があります。 有効な値: custom、mission、occupation、outlook。 keywords[].value string キーワード。
deletionTime	string 出力のみ。ユーザーのアカウントが削除された時刻。値は ISO 8601 の日付と時刻の形式です。時刻は、完全な日付に時、分、秒を加えたもので、YYYY-MM-DDThh:mm:ssTZD の形式で指定します。例: 2010-04-05T17:30:04+01:00。
gender	value (Value format) ユーザーの性別を含むネストされたオブジェクト。このフィールドで使用できる最大データサイズは 1 KB です。 フィールド gender.addressMeAs string 人がプロファイル オーナーを参照する適切な方法を含む、人が読める形式の文字列（例: 「he/him/his」「they/them/their」）。 gender.customGender string カスタムの性別の名前。 gender.type string 性別のタイプ。 使用できる値: female male other unknown
thumbnailPhotoEtag	string 出力のみ。ユーザーの写真の ETag（読み取り専用）
ims	value (Value format) ユーザーのインスタント メッセンジャー（IM）アカウント。1 つのユーザー アカウントに複数の ims プロパティを設定できますが、プライマリ IM の連絡先に指定できるのは、これらの ims プロパティのうち 1 つだけです。 フィールド ims[].customProtocol string プロトコル値が custom_protocol の場合、このプロパティはカスタム プロトコルの文字列を保持します。 ims[].customType string IM type が custom の場合、このプロパティにはカスタム値が含まれているため、設定する必要があります。 ims[].im string ユーザーの IM ネットワーク ID。 ims[].primary boolean これがユーザーのプライマリ IM である場合。IM リストのエントリは、1 つのみ true です。 ims[].protocol string IM プロトコルは、IM ネットワークを識別します。この値には、カスタム ネットワークまたは標準ネットワークを指定できます。 使用できる値: aim: AOL Instant Messenger プロトコル custom_protocol: カスタム IM ネットワーク プロトコル gtalk: Google トーク プロトコル icq: ICQ プロトコル jabber: Jabber プロトコル msn: MSN Messenger プロトコル net_meeting: ネット会議プロトコル qq: QQ プロトコル skype: Skype プロトコル yahoo: Yahoo Messenger プロトコル ims[].type string IM アカウントのタイプ。custom に設定する場合は、customType も設定する必要があります。 有効な値: custom、home、other、work。
customSchemas	value (Value format) ユーザーのカスタム フィールド。指定できるデータサイズは最大 32 KB です。キーは schemaName で、その値は 'fieldName': 'field_value' です。 customSchemas.(key) はネストされたオブジェクトです。 customSchemas.(key).(key) には任意の値を指定できます。
isEnrolledIn2Sv	boolean 出力のみ。2 段階認証プロセスに登録している（読み取り専用）
isEnforcedIn2Sv	boolean 出力のみ。2 段階認証プロセスが適用されている（読み取り専用）
archived	boolean ユーザーがアーカイブされているかどうかを示します。
orgUnitPath	string ユーザーに関連付けられている親組織のフルパス。親組織が最上位の場合はスラッシュ（/）で表されます。
recoveryEmail	string ユーザーの再設定用のメールアドレス。
recoveryPhone	string ユーザーの再設定用の電話番号。電話番号は、プラス記号（+）から始まる E.164 形式で指定してください（例: [phone]）。

UserName

JSON 表現
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string }

フィールド
fullName	string 姓と名の値を連結して形成されたユーザーの氏名。
familyName	string ユーザーの姓。ユーザー アカウントの作成時に必須。
givenName	string ユーザーの名。ユーザー アカウントの作成時に必須。
displayName	string ユーザーの表示名。（上限: 256 文字）。

Methods
delete	ユーザーを削除します。
get	ユーザーを取得します。
insert	ユーザーを作成します。
list	削除済みのユーザーまたはドメイン内のすべてのユーザーを含む、ページ分けされたリストを取得します。
makeAdmin	ユーザーを特権管理者にします。
patch	パッチのセマンティクスを使用して、ユーザーを更新します。
signOut	ユーザーをすべてのウェブ セッションとデバイス セッションからログアウトさせ、ログイン Cookie をリセットします。
undelete	ユーザーの削除を取り消します。
update	ユーザーを更新します。
watch	ユーザーリストの変更を監視します。