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 です。また、name 値は 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、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

型の値がカスタムの場合、このプロパティにはカスタム型が含まれます。

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 つだけです。

phones[].type

string

電話番号の種類。custom に設定した場合は、customType も設定する必要があります。

有効な値: assistant、callback、car、company_main、grand_central、home、home_fax、isdn、main、mobile、other、other_fax、pager、radio、telex、tty_tdd、work、work_fax

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 アカウント フィールド ID。

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

ユーザー名またはユーザーが適用されるシステムのシステム識別子。

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 のラベルを付けます。また、1 つのエントリに custom 型を設定することもできます。custom に設定する場合は、customType も設定する必要があります。

有効な値: app_install_page、blog、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/they」）を含む、人が読める文字列。

gender.customGender

string

カスタムの性別の名前。

gender.type

string

 性別の種類。

有効な値:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

出力のみ。ユーザーの写真の ETag（読み取り専用）
ims

value (Value format)

ユーザーの Instant Messenger（IM）アカウント。1 つのユーザー アカウントに複数の ims プロパティを設定できますが、メインの IM 連絡先に設定できるのは 1 つの ims プロパティのみです。

フィールド

ims[].customProtocol

string

プロトコル値が custom_protocol の場合、このプロパティはカスタム プロトコルの文字列を保持します。

ims[].customType

string

IM type が custom の場合、このプロパティにはカスタム値が含まれているため、設定する必要があります。

ims[].im

string

ユーザーの IM ネットワーク ID。

ims[].primary

boolean

これがユーザーの主要な IM の場合です。IM リスト内の値を true として指定できるのは 1 つのみです。

ims[].protocol

string

 IM プロトコルは IM ネットワークを識別します。カスタム ネットワークまたは標準ネットワークを使用できます。

有効な値:
  • aim: AOL インスタント メッセンジャー プロトコル
  • custom_protocol: カスタム IM ネットワーク プロトコル
  • gtalk: Google トーク プロトコル
  • icq: ICQ プロトコル
  • jabber: Jabber プロトコル
  • msn: MSN Messenger プロトコル
  • net_meeting: Net Meeting プロトコル
  • qq: QQ プロトコル
  • skype: Skype プロトコル
  • yahoo: Yahoo Messenger のプロトコル

ims[].type

string

IM アカウントの種類。custom に設定する場合は、customType も設定する必要があります。

有効な値: custom、home、other、work。
customSchemas

value (Value format)

ユーザーのカスタム フィールド。キーは 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 形式で、プラス記号（+）で始まる必要があります（例: +16506661212）。

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

 ユーザーリストの変更を監視します。