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 のレスポンス本文で返されることはありません。

パスワードには 8 ~ 100 文字の ASCII 文字を自由に組み合わせて含めることができます。

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 値を保持します。givenNamefamilyName の値で指定できる最大文字数は 60 文字です。また、名前の値は Unicode/UTF-8 文字に対応しており、スペース、英字(a ~ z)、数字(0 ~ 9)、ダッシュ(-)、スラッシュ(/)、ピリオド(.)を使用できます。文字の使用ルールの詳細については、管理者向けヘルプセンターをご覧ください。このフィールドに指定できるデータサイズは最大 1 KB です。

kind

string

出力のみ。API リソースのタイプ。ユーザー リソースの場合、値は admin#directory#user です。

etag

string

出力のみ。リソースの ETag。

emails

value (Value format)

ユーザーのメールアドレスのリスト。指定できるデータサイズは最大 10 KB です。

フィールド

emails[].address

string

ユーザーのメールアドレス。メール ID としても機能します。この値には、ユーザーのメインのメールアドレスまたはエイリアスを指定できます。

emails[].customType

string

メールアドレス typecustom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。

emails[].primary

boolean

これがユーザーのプライマリ メールアドレスかどうかを示します。メインとしてマークできるエントリは 1 つだけです。

emails[].type

string

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

使用できる値は customhomeotherwork です。

externalIds

value (Value format)

従業員の外部 ID(従業員 ID やネットワーク ID など)のリスト。指定できるデータサイズは最大 2 KB です。

フィールド

externalIds[].customType

string

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

externalIds[].type

string

外部 ID のタイプ。custom に設定した場合は、customType も設定する必要があります。

使用できる値は、accountcustomcustomerlogin_idnetworkorganization です。

externalIds[].value

string

外部 ID の値。

relations

value (Value format)

ユーザーと他のユーザーとの関係のリスト。このフィールドに指定できるデータサイズは最大 2 KB です。詳しくは、ユーザー アカウントを管理するをご覧ください。

フィールド

relations[].customType

string

リレーション typecustom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。

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

アドレス typecustom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。

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 も設定する必要があります。

使用できる値は customhomeotherwork です。

organizations

value (Value format)

ユーザーが所属する組織のリスト。指定できるデータサイズは最大 10 KB です。

フィールド

organizations[].costCenter

string

ユーザーの組織のコストセンター。

organizations[].customType

string

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

organizations[].department

string

組織内の部門を指定します(例: salesengineering)。

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

組織内でのユーザーの役職。(memberengineer など)が使用されます。

organizations[].type

string

組織のタイプ。

使用できる値: domain_onlyschoolunknownwork

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

電話番号 typecustom の場合、このプロパティにはカスタム値が含まれており、設定する必要があります。

phones[].primary

boolean

true の場合、ユーザーのメインの電話番号です。1 人のユーザーが設定できるメインの電話番号は 1 つのみです。

phones[].type

string

電話番号のタイプ。custom に設定する場合は、customType も設定する必要があります。

使用可能な値: assistantcallbackcarcompany_maincustomgrand_centralhomehome_faxisdnmainmobileotherother_faxpagerradiotelextty_tddwork

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 が設定されている場合は、設定できません。指定できる値は preferrednot_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

このアカウントのオペレーティング システムの種類。

使用できる値: linuxunspecifiedwindows

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_plaintext_html

notes.value

string

メモの内容。

websites

value (Value format)

ユーザーのウェブサイトのリスト。

フィールド

websites[].customType

string

ウェブサイト typecustom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。

websites[].primary

boolean

true の場合、ユーザーのプライマリ ウェブサイトです。

websites[].type

string

ウェブサイトの種類または目的。たとえば、ウェブサイトには homeblog というラベルを付けます。また、エントリに custom 型を設定することもできます。custom に設定する場合は、customType も設定する必要があります。

使用できる値: app_install_pageblogcustomftphomehome_pageotherprofilereservationsresumework

websites[].value

string

ウェブサイトの URL。

locations

value (Value format)

ユーザーの勤務地のリスト。指定できるデータサイズは最大 10 KB です。

フィールド

locations[].area

string

テキストでの場所これは、場所について簡潔に説明する表示目的で特に便利です。(Mountain View, CANear Seattle など)が使用されます。

locations[].buildingId

string

ビルディング ID。

locations[].customType

string

場所 typecustom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。

locations[].deskCode

string

個々のデスクの場所を最も具体的なテキストで表したコードです。

locations[].floorName

string

階の名前/番号。

locations[].floorSection

string

階のセクション。階内のより具体的な場所。たとえば、階が ABC のセクションに分割されている場合、このフィールドはそれらの値のいずれかを表します。

locations[].type

string

ロケーション タイプ。custom に設定する場合は、customType も設定する必要があります。

使用できる値は customdefaultdesk です。

includeInGlobalAddressList

boolean

ドメインで連絡先の共有機能が有効になっている場合、ユーザーのプロフィールが Google Workspace のグローバル アドレス一覧に表示されるかどうかを示します。ユーザー プロファイルの除外について詳しくは、管理者向けヘルプセンターをご覧ください。

keywords

value (Value format)

ユーザーのキーワードのリスト。指定できるデータサイズは最大 1 KB です。

フィールド

keywords[].customType

string

キーワード typecustom の場合、このプロパティにはカスタム値が含まれ、設定する必要があります。

keywords[].type

string

各エントリには、そのエントリの標準的なタイプを示す type を指定できます。

たとえば、キーワードのタイプは occupationoutlook です。エントリには標準タイプに加えて custom タイプを含めることができ、任意の名前を付けることができます。custom に設定した場合は、customType も設定する必要があります。

使用できる値は custommissionoccupationoutlook です。

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 typecustom の場合、このプロパティにはカスタム値が含まれており、設定する必要があります。

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 も設定する必要があります。

使用できる値は customhomeotherwork です。

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 文字(全角 128 文字)

Methods

delete

ユーザーを削除します。

get

ユーザーを取得します。

insert

ユーザーを作成します。

list

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

makeAdmin

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

patch

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

signOut

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

undelete

ユーザーの削除を取り消します。

update

ユーザーを更新します。

watch

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