REST Resource: users

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース: User

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

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 値を保持します。givenNamefamilyName の値の最大文字数は 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

メールアドレス 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

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

organizations[].department

string

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

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

組織内でのユーザーの役職。(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 つのみです。

phones[].type

string

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

有効な値: assistantcallbackcarcompany_maincustomgrand_centralhomehome_faxisdnmainmobileotherother_faxpagerradiotelextty_tddworkwork_fax

phones[].value

string

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

suspensionReason

string

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

thumbnailPhotoUrl

string

出力のみ。ユーザーの写真 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

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

有効な値: linuxunspecifiedwindows

posixAccounts[].primary

boolean

これが SystemId 内のユーザーのメイン アカウントである場合。

posixAccounts[].shell

string

このアカウントのログインシェルのパスです。

posixAccounts[].systemId

string

Username または 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

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

たとえば、キーワードのタイプは 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」や「them/them/them」など)。

gender.customGender

string

カスタムの性別の名前。

gender.type

string

性別のタイプ。

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

thumbnailPhotoEtag

string

出力のみ。ユーザーの写真の ETag(読み取り専用)

ims

value (Value format)

ユーザーの Instant Messenger(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 リスト内の 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 も設定する必要があります。

有効な値: 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 文字)。

Methods

delete

ユーザーを削除します。

get

ユーザーを取得します。

insert

ユーザーを作成します。

list

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

makeAdmin

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

patch

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

signOut

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

undelete

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

update

ユーザーを更新します。

watch

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