このページは Cloud Translation API によって翻訳されました。

REST Resource: users

リソース: User

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

JSON 表現

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,
  "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 つのみです。

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_faxwork_mobilework_pager

phones[].value

string

人が読める形式の電話番号。任意の電話番号形式を使用できます。

suspensionReason

string

出力専用。ユーザーアカウントが、停止時に管理者または Google によって停止された理由がある。このプロパティは、suspended プロパティが true の場合にのみ返されます。

thumbnailPhotoUrl

string

出力専用。ユーザーのプロフィール写真の URL。この 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

ユーザー名または 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

建物 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」など）または「彼ら/彼ら/彼ら」。

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 リストの中で、値を 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 Protocol
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 文字。

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

REST Resource: users

リソース: User

UserName

メソッド

`delete`

`get`

`insert`

`list`

`makeAdmin`

`patch`

`signOut`

`undelete`

`update`

`watch`