リソース: 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 ( |
フィールド | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
ユーザーの一意の ID。ユーザー |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
ユーザーのメインのメールアドレス。ユーザー アカウントの作成リクエストには、このプロパティが必要です。 |
||||||||||||||||||||||||||||||||||||||||||
password |
ユーザー アカウントのパスワードを保存します。ユーザー アカウントの作成時には、ユーザーのパスワード値が必要です。ユーザーを更新する場合は省略可能ですが、ユーザーがアカウントのパスワードを更新する場合にのみ指定します。パスワードの値が API のレスポンスの本文で返されることはありません。 |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
接頭辞の一部としてラウンドを指定する場合は、10,000 以下である必要があります。 |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
出力のみ。特権管理者権限を持つユーザーを示します。 |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
出力のみ。ユーザーが代理管理者かどうかを示します。 |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
出力のみ。ユーザーが初回ログインを完了し、利用規約に同意した場合は、このプロパティが |
||||||||||||||||||||||||||||||||||||||||||
suspended |
ユーザーが停止されているかどうかを示します。 |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
ユーザーが次回ログインするときに、強制的にパスワードを変更する必要があるかどうかを示します。ユーザーがサードパーティの ID プロバイダ経由でログインする場合、この設定は適用されません。 |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
|
||||||||||||||||||||||||||||||||||||||||||
name |
ユーザーの氏名とファミリー名、読み取り専用の |
||||||||||||||||||||||||||||||||||||||||||
kind |
出力のみ。API リソースのタイプ。Users リソースの場合、値は |
||||||||||||||||||||||||||||||||||||||||||
etag |
出力のみ。リソースの ETag。 |
||||||||||||||||||||||||||||||||||||||||||
emails |
ユーザーのメールアドレスのリスト。指定できるデータの最大サイズは 10 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
社員の ID やネットワーク ID など、ユーザーの外部 ID のリスト。最大データサイズは 2 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
relations |
ユーザーと他のユーザーとの関係のリスト。このフィールドで許可されるデータサイズは最大 2 KB です。詳しくは、ユーザー アカウントの管理をご覧ください。
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
出力のみ。ユーザーのエイリアス メールアドレスのリスト。 |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
出力のみ。ユーザーの Google メールボックスが作成されたかどうかを示します。このプロパティは、ユーザーに Gmail ライセンスが割り当てられている場合にのみ適用されます。 |
||||||||||||||||||||||||||||||||||||||||||
customerId |
出力のみ。すべてのアカウント ユーザーを取得するためのお客様 ID。 |
||||||||||||||||||||||||||||||||||||||||||
addresses |
ユーザーの住所のリスト。指定できるデータの最大サイズは 10 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
ユーザーが所属する組織のリスト。指定できるデータの最大サイズは 10 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
出力のみ。ユーザーが最後にアカウントにログインした日時。値は ISO 8601 の日時形式です。時刻は、完全な日付に時、分、秒を加えた形式( |
||||||||||||||||||||||||||||||||||||||||||
phones |
ユーザーの電話番号のリスト。指定できるデータサイズは最大 1 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
出力のみ。ユーザー アカウントの停止時に、管理者または Google がユーザー アカウントを停止する理由があります。プロパティは、 |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
出力のみ。ユーザーのプロフィール写真の URL。URL は一時的または非公開である可能性があります。 |
||||||||||||||||||||||||||||||||||||||||||
languages |
ユーザーの言語のリスト。指定できるデータサイズは最大 1 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
ユーザーの POSIX アカウント情報のリスト。
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
出力のみ。ユーザーのアカウントが作成された時刻。値は ISO 8601 の日時形式です。時刻は、完全な日付に時、分、秒を加えた形式( |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
出力のみ。ユーザーの編集不可能なエイリアス メールアドレスのリスト。これらは通常、アカウントのプライマリ ドメインまたはサブドメイン外にあります。 |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
SSH 公開鍵のリスト。
|
||||||||||||||||||||||||||||||||||||||||||
notes |
ネストされたオブジェクトとしてのユーザーのメモ。
|
||||||||||||||||||||||||||||||||||||||||||
websites |
ユーザーのウェブサイトのリスト。
|
||||||||||||||||||||||||||||||||||||||||||
locations |
ユーザーの所在地のリスト。指定できるデータの最大サイズは 10 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
ドメインで連絡先の共有機能が有効になっている場合、ユーザーのプロフィールが Google Workspace グローバル アドレス一覧に表示されているかどうかを示します。ユーザー プロフィールの除外について詳しくは、管理者向けヘルプセンターをご覧ください。 |
||||||||||||||||||||||||||||||||||||||||||
keywords |
ユーザーのキーワードのリスト。指定できるデータサイズは最大 1 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
出力のみ。ユーザーのアカウントが削除された時刻。値は ISO 8601 の日時形式です。時刻は、完全な日付に時、分、秒を加えた形式( |
||||||||||||||||||||||||||||||||||||||||||
gender |
ユーザーの性別を含むネストされたオブジェクト。このフィールドで許可されるデータサイズは最大 1 KB です。
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
出力のみ。ユーザーの写真の ETag(読み取り専用) |
||||||||||||||||||||||||||||||||||||||||||
ims |
ユーザーの Instant Messenger(IM)アカウント。1 つのユーザー アカウントに複数の
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
ユーザーのカスタム フィールド。キーは
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
出力のみ。2 段階認証プロセスに登録している(読み取り専用) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
出力のみ。2 段階認証プロセスが適用されている(読み取り専用) |
||||||||||||||||||||||||||||||||||||||||||
archived |
ユーザーがアーカイブされているかどうかを示します。 |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
ユーザーに関連付けられた親組織のフルパス。親組織がトップレベルの場合、スラッシュ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
ユーザーの再設定用のメールアドレス。 |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
お客様の再設定用の電話番号。電話番号は E.164 形式で、プラス記号(+)で始まる必要があります(例: +16506661212)。 |
UserName
JSON 表現 |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
フィールド | |
---|---|
fullName |
ユーザーの姓名を連結して形成されたユーザーの氏名。 |
familyName |
ユーザーの姓。ユーザー アカウントを作成する場合は必須です。 |
givenName |
ユーザーの名。ユーザー アカウントを作成する場合は必須です。 |
displayName |
ユーザーの表示名。上限: 256 文字。 |
Methods |
|
---|---|
|
ユーザーを削除します。 |
|
ユーザーを取得します。 |
|
ユーザーを作成します。 |
|
削除されたユーザーまたはドメイン内のすべてのユーザーのページ分けされたリストを取得します。 |
|
ユーザーを特権管理者にします。 |
|
パッチのセマンティクスを使用してユーザーを更新します。 |
|
すべてのウェブとデバイスのセッションからログアウトし、ログイン Cookie をリセットします。 |
|
削除されたユーザーの削除を取り消します。 |
|
ユーザーを更新します。 |
|
ユーザーリストの変更を監視します。 |