Method: users.patch

パッチ セマンティクスを使用してユーザーを更新します。代わりに update メソッドを使用することをおすすめします。このメソッドはパッチのセマンティクスもサポートしており、パフォーマンスも優れています。外部 ID を Google ID にマッピングする場合は、patch メソッドではなく update メソッドを使用します。

HTTP リクエスト

PATCH https://admin.googleapis.com/admin/directory/v1/users/{userKey}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userKey

string

API リクエストでユーザーを識別します。この値は、ユーザーのメインのメールアドレス、エイリアス メールアドレス、一意のユーザー ID のいずれかです。

リクエストの本文

リクエストの本文には User のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には User のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/admin.directory.user

詳しくは、認可ガイドをご覧ください。