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,
  "isGuestUser": boolean,
  "guestAccountInfo": {
    object (GuestAccountInfo)
  }
}
フィールド
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 暗号ライブラリに準拠しています。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

組織内のフルタイム換算のミリパーセント（100000 = 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、custom、grand_central、home、home_fax、isdn、main、mobile、other、other_fax、pager、radio、telex、tty_tdd、work、work_fax、work_mobile、work_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 が適用されるシステム識別子。

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

建物の識別子。

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

人がプロファイル所有者を指す適切な方法を含む、人が読める形式の文字列（「彼/彼/彼の」や「彼ら/彼ら/彼らの」など）。

gender.customGender

string

カスタムの性別の名前。

gender.type

string

 性別のタイプ。

使用できる値:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

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

value (Value format)

ユーザーのインスタント メッセージ（IM）アカウント。ユーザー アカウントには複数の 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 リストで true の値を持つことができるエントリは 1 つだけです。

ims[].protocol

string

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

使用できる値:
  • aim: AOL Instant Messenger プロトコル
  • custom_protocol: カスタム IM ネットワーク プロトコル
  • gtalk: Google Talk プロトコル
  • 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。
isGuestUser

boolean

変更不可。ユーザーがゲストかどうかを示します。
guestAccountInfo

object (GuestAccountInfo)

変更不可。ゲスト関連の追加のメタデータ フィールド

ユーザー名

JSON 表現 
{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}
フィールド
fullName

string

姓と名の値を連結して作成されたユーザーのフルネーム。
familyName

string

ユーザーの姓。ユーザー アカウントの作成時に必要です。
givenName

string

ユーザーの名。ユーザー アカウントの作成時に必要です。
displayName

string

ユーザーの表示名。上限: 256 文字。

GuestAccountInfo

ゲストユーザーに固有のアカウント情報。

JSON 表現 
{
  "primaryGuestEmail": string
}
フィールド
primaryGuestEmail

string

変更不可。ゲストの外部メール。

メソッド

createGuest

 Workspace の機能の一部にアクセスできるゲストユーザーを作成します。

delete

 ユーザーを削除します。

get

 ユーザーを取得します。

insert

 ユーザーを作成します。

list

 削除されたユーザーまたはドメイン内のすべてのユーザーのページ分割されたリストを取得します。

makeAdmin

 ユーザーを特権管理者にします。

patch

 パッチ セマンティクスを使用してユーザーを更新します。

signOut

 すべてのウェブ セッションとデバイス セッションからユーザーをログアウトさせ、ログイン Cookie をリセットします。

undelete

 削除したユーザーを復元します。

update

 ユーザーを更新します。

watch

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