Method: projects.locations.tenants.patch

単一のテナントを更新します。

HTTP リクエスト

PATCH https://saasservicemgmt.googleapis.com/v1beta1/{tenant.name=projects/*/locations/*/tenants/*}

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

パスパラメータ

パラメータ
tenant.name

string

ID。標準の命名スキームに沿ったリソース名(リソースの完全な URI)。

"projects/{project}/locations/{location}/tenants/{tenant}"

クエリ パラメータ

パラメータ
validateOnly

boolean

validateOnly が true に設定されている場合、サービスはこのリクエストが成功するかどうかを検証しようとしますが、実際には変更は行いません。

requestId

string

リクエストを識別するリクエスト ID(省略可)。一意のリクエスト ID を指定することで、リクエストの再試行が必要なときに、リクエストが完了していれば、サーバーがリクエストを無視できるようになります。サーバーは、最初のリクエストから少なくとも 60 分間はこれを保証します。

たとえば、最初のリクエストを行い、そのリクエストがタイムアウトしたとします。同じリクエスト ID で再度リクエストを行うと、サーバーは元のオペレーションを同じリクエスト ID で受信していたかどうかを確認できます。受信していた場合は、2 回目のリクエストは無視されます。これにより、クライアントが重複するコミットを誤って作成することを防ぐことができます。

リクエスト ID は有効な UUID でなければなりません。ただし、ゼロ UUID(00000000-0000-0000-0000-000000000000)はサポートされていません。

updateMask

string (FieldMask format)

フィールド マスクは、更新によって Tenant リソース内で上書きされるフィールドを指定するために使用されます。

updateMask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。

ユーザーがマスクを指定しなければ、テナント内のすべてのフィールドが上書きされます。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • saasservicemgmt.tenants.update

詳細については、IAM のドキュメントをご覧ください。