Package google.cloud.identitytoolkit.v2beta1

インデックス

ProjectConfigService

Identity Toolkit のプロジェクト構成

CreateDefaultSupportedIdpConfig

rpc CreateDefaultSupportedIdpConfig(CreateDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Identity Toolkit プロジェクト用に、デフォルトでサポートされている IdP 構成を作成します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc CreateInboundSamlConfig(CreateInboundSamlConfigRequest) returns (InboundSamlConfig)

Identity Toolkit プロジェクトのインバウンド SAML 構成を作成します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc CreateOAuthIdpConfig(CreateOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Identity Toolkit プロジェクトの Oidc Idp 構成を作成します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc DeleteDefaultSupportedIdpConfig(DeleteDefaultSupportedIdpConfigRequest) returns (Empty)

Identity Toolkit プロジェクトのデフォルトでサポートされている IdP 構成を削除します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc DeleteInboundSamlConfig(DeleteInboundSamlConfigRequest) returns (Empty)

Identity Toolkit プロジェクトのインバウンド SAML 構成を削除します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc DeleteOAuthIdpConfig(DeleteOAuthIdpConfigRequest) returns (Empty)

Identity Toolkit プロジェクトの Oidc Idp 構成を削除します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc EnableCicp(EnableCicpRequest) returns (EnableCicpResponse)

Cloud プロジェクトで CICP を有効にします。Cloud Identity for Customers and Partners（CICP）は、サードパーティのユーザーがアプリやサービスにアクセスするためのエンドツーエンドの認証システムです。モバイルアプリやウェブアプリ、ゲーム、API などです。

認可スコープ

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

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

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

rpc GetConfig(GetConfigRequest) returns (Config)

Identity Toolkit プロジェクト構成を取得します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc GetDefaultSupportedIdpConfig(GetDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Identity Toolkit プロジェクトでサポートされているデフォルトの IdP 構成を取得します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc GetInboundSamlConfig(GetInboundSamlConfigRequest) returns (InboundSamlConfig)

Identity Toolkit プロジェクトのインバウンド SAML 構成を取得します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc GetOAuthIdpConfig(GetOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Identity Toolkit プロジェクトの Oidc Idp 構成を取得します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc ListDefaultSupportedIdpConfigs(ListDefaultSupportedIdpConfigsRequest) returns (ListDefaultSupportedIdpConfigsResponse)

Identity Toolkit プロジェクトでデフォルトでサポートされているすべての Idp 構成を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc ListDefaultSupportedIdps(ListDefaultSupportedIdpsRequest) returns (ListDefaultSupportedIdpsResponse)

デフォルトでサポートされているすべての IDP を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc ListInboundSamlConfigs(ListInboundSamlConfigsRequest) returns (ListInboundSamlConfigsResponse)

Identity Toolkit プロジェクトのすべてのインバウンド SAML 構成を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc ListOAuthIdpConfigs(ListOAuthIdpConfigsRequest) returns (ListOAuthIdpConfigsResponse)

Identity Toolkit プロジェクトのすべての Oidc Idp 構成を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc UpdateConfig(UpdateConfigRequest) returns (Config)

Identity Toolkit プロジェクトの構成を更新する。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc UpdateDefaultSupportedIdpConfig(UpdateDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Identity Toolkit プロジェクトのデフォルトでサポートされている IdP 構成を更新します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc UpdateInboundSamlConfig(UpdateInboundSamlConfigRequest) returns (InboundSamlConfig)

Identity Toolkit プロジェクトのインバウンド SAML 構成を更新します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc UpdateOAuthIdpConfig(UpdateOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Identity Toolkit プロジェクトの Oidc Idp 構成を更新します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc VerifyDomain(VerifyDomainRequest) returns (VerifyDomainResponse)

リクエストされたカスタム ドメインに必要な DNS レコードがあることを確認します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

TenantManagementService

GCIP のテナント管理サービス。

CreateTenant

rpc CreateTenant(CreateTenantRequest) returns (Tenant)

テナントを作成します。エージェント プロジェクトに対する書き込み権限が必要です。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc DeleteTenant(DeleteTenantRequest) returns (Empty)

テナントを削除します。エージェント プロジェクトに対する書き込み権限が必要です。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc GetTenant(GetTenantRequest) returns (Tenant)

テナントを取得します。テナント リソースに対する読み取り権限が必要です。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc ListTenants(ListTenantsRequest) returns (ListTenantsResponse)

指定されたエージェント プロジェクトの下にあるテナントを一覧表示します。エージェント プロジェクトに対する読み取り権限が必要です。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

rpc UpdateTenant(UpdateTenantRequest) returns (Tenant)

テナントを更新します。テナント リソースに対する書き込み権限が必要です。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

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

BlockingFunctionsConfig

ブロッキング関数に関連する構成。

フィールド
triggers

map<string, Trigger>

トリガーとイベントタイプのマップ。キーは、サポートされているイベントタイプ（「beforeCreate」、「beforeSignIn」）のいずれかである必要があります。

トリガー

HTTP トリガーを使用した同期 Cloud Functions 関数

フィールド
function_uri

string

Cloud Functions の関数の HTTP URI トリガー。
update_time

Timestamp

トリガーが変更された日時。

ClientConfig

プロジェクトに代わってリクエストを行うクライアントの設定方法に関連するオプション。

フィールド
api_key

string

出力専用。このプロジェクトのリクエスト時に使用できる API キー。
permissions

Permissions

ユーザーがアカウントに影響を与える機能を制限する構成。
firebase_subdomain

string

出力専用。Firebase のサブドメイン。

権限

ユーザーがアカウントに影響を与える機能を制限する構成。

フィールド
disabled_user_signup

bool

true に設定すると、エンドユーザーは API メソッドを使用して、関連付けられたプロジェクトで新しいアカウントを登録できなくなります。
disabled_user_deletion

bool

true の場合、エンドユーザーは API メソッドを使用して、関連付けられたプロジェクトのアカウントを削除できません。

構成

Identity Toolkit プロジェクトを表します。

フィールド
name

string

出力専用。Config リソースの名前。例: "projects/my-awesome-project/config"
sign_in

SignInConfig

ローカル ログイン方法に関連する構成。
notification

NotificationConfig

ユーザーへの通知の送信に関連する設定。
quota

QuotaConfig

割り当てに関連する構成。
monitoring

MonitoringConfig

プロジェクト アクティビティのモニタリングに関連する構成。
authorized_domains[]

string

OAuth リダイレクトが承認されているドメインのリスト
subtype

Subtype

出力専用。この構成のサブタイプ。
client

ClientConfig

プロジェクトに代わってリクエストを行うクライアントの設定方法に関連するオプション。
mfa

MultiFactorAuthConfig

このプロジェクトの多要素認証の構成（有効かどうか、2 つ目の要素に使用できる要素など）
blocking_functions

BlockingFunctionsConfig

ブロッキング関数に関連する構成。

サブタイプ

この構成のサブタイプ。

列挙型
SUBTYPE_UNSPECIFIED デフォルト値。使用しないでください。
CUSTOMER_IDENTITY Customer Identity プロジェクト。
FIREBASE_AUTH Firebase Authentication プロジェクト。

CreateDefaultSupportedIdpConfigRequest

CreateDefaultSupportedIdpConfig のリクエスト

フィールド
parent

string

構成を作成する親リソース名（例: projects/my-awesome-project）。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update
idp_id

string

構成を作成する IdP の ID。ListDefaultSupportedIdps を呼び出して、サポートされているすべてのデフォルトの IdP のリストを取得します。
default_supported_idp_config

DefaultSupportedIdpConfig

サーバー上のリソースを置き換える config リソース。

CreateInboundSamlConfigRequest

CreateInboundSamlConfig のリクエスト

フィールド
parent

string

構成を作成する親リソース名（例:「projects/my-awesome-project」）。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update
inbound_saml_config_id

string

この構成に使用する ID。
inbound_saml_config

InboundSamlConfig

作成する config リソース。クライアントは InboundSamlConfig.name フィールドを設定できません。クライアントが設定した場合、サーバーはフィールド値を無視します。

CreateOAuthIdpConfigRequest

CreateOAuthIdpConfig のリクエスト

フィールド
parent

string

構成を作成する親リソース名（例: projects/my-awesome-project）。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update
oauth_idp_config_id

string

この構成に使用する ID。
oauth_idp_config

OAuthIdpConfig

作成する config リソース。クライアントは OAuthIdpConfig.name フィールドを設定できません。クライアントが設定した場合、サーバーはフィールド値を無視します。

CreateTenantRequest

CreateTenant に対するリクエスト メッセージです。

フィールド
parent

string

テナントが作成される親リソース名。たとえば、「projects/project1」です。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • identitytoolkit.tenants.create
tenant

Tenant

必須。作成するテナント。

DefaultSupportedIdp

標準の Identity Toolkit で信頼できる IDP。

フィールド
idp_id

string

IdP の ID
description

string

Idp の説明

DefaultSupportedIdpConfig

Identity Toolkit で信頼されている IDP の標準セットで認証するための構成オプション。

フィールド
name

string

DefaultSupportedIdpConfig リソースの名前（例:「projects/my-awesome-project/defaultSupportedIdpConfigs/google.com」）。
enabled

bool

ユーザーがプロバイダでログインできるようにする場合は true。
client_id

string

OAuth クライアント ID] をクリックします。
client_secret

string

OAuth クライアント シークレット。
display_on_cloud_console

bool

出力専用。IdP が無効な状態の場合に、Pantheon に IdP 構成を表示するかどうか。

DeleteDefaultSupportedIdpConfigRequest

DeleteDefaultSupportedIdpConfig のリクエスト

フィールド
name

string

構成のリソース名（例: projects/my-awesome-project/defaultSupportedIdpConfigs/google.com）

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update

DeleteInboundSamlConfigRequest

DeleteInboundSamlConfig のリクエスト

フィールド
name

string

削除する構成のリソース名。例: projects/my-awesome-project/inboundSamlConfigs/my-config-id。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update

DeleteOAuthIdpConfigRequest

DeleteOAuthIdpConfig のリクエスト

フィールド
name

string

削除する構成のリソース名。例: projects/my-awesome-project/oauthIdpConfigs/oauth-config-id。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update

DeleteTenantRequest

DeleteTenant に対するリクエスト メッセージ。

フィールド
name

string

削除するテナントのリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • identitytoolkit.tenants.delete

EnableCicpRequest

EnableCicp のリクエスト。

フィールド
project

string

デベロッパーが CICP を有効にするターゲット プロジェクトのリソース名。

認可には、指定されたリソース project に対する次の IAM の権限が必要です。

  • firebaseauth.configs.create

EnableCicpResponse

この型にはフィールドがありません。

EnableCicp に対するレスポンス。現時点では空です。

GetConfigRequest

GetConfig のリクエスト

フィールド
name

string

構成のリソース名（例:「projects/my-awesome-project/config」）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • firebaseauth.configs.get

GetDefaultSupportedIdpConfigRequest

GetDefaultSupportedIdpConfig のリクエスト

フィールド
name

string

構成のリソース名（例: projects/my-awesome-project/defaultSupportedIdpConfigs/google.com）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • firebaseauth.configs.get

GetInboundSamlConfigRequest

GetInboundSamlConfig のリクエスト

フィールド
name

string

構成のリソース名（例: projects/my-awesome-project/inboundSamlConfigs/my-config-id）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • firebaseauth.configs.get

GetOAuthIdpConfigRequest

GetOAuthIdpConfig のリクエスト

フィールド
name

string

構成のリソース名（例: projects/my-awesome-project/oauthIdpConfigs/oauth-config-id）。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • firebaseauth.configs.get

GetTenantRequest

GetTenant に対するリクエスト メッセージです。

フィールド
name

string

取得するテナントのリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • identitytoolkit.tenants.get

HashConfig

ハッシュ アルゴリズムと鍵の履歴情報。アカウントごとに異なるバージョンでパスワードが生成される場合があります。

フィールド
algorithm

HashAlgorithm

出力専用。Identity Toolkit で使用されるさまざまなパスワード ハッシュ アルゴリズム。
signer_key

string

出力専用。署名者の鍵（Base64 形式）。
salt_separator

string

出力専用。ソルトと平文パスワードの間に挿入される base64 の印刷不可文字。
rounds

int32

出力専用。ハッシュ計算のラウンド数。scrypt などの同様のパスワード派生アルゴリズムで使用されます。
memory_cost

int32

出力専用。ハッシュ計算のメモリコスト。scrypt やその他の同様のパスワード派生アルゴリズムで使用されます。フィールドの説明については、https://tools.ietf.org/html/rfc7914 をご覧ください。

HashAlgorithm

Identity Toolkit で使用されるさまざまなパスワード ハッシュ アルゴリズム。

列挙型
HASH_ALGORITHM_UNSPECIFIED デフォルト値。使用しないでください。
HMAC_SHA256 HMAC_SHA256
HMAC_SHA1 HMAC_SHA1
HMAC_MD5 HMAC_MD5
SCRYPT SCRYPT
PBKDF_SHA1 PBKDF_SHA1
MD5 MD5
HMAC_SHA512 HMAC_SHA512
SHA1 SHA1
BCRYPT BCRYPT
PBKDF2_SHA256 PBKDF2_SHA256
SHA256 SHA256
SHA512 SHA512
STANDARD_SCRYPT STANDARD_SCRYPT

IdpCertificate

IDP が発行した SAMLResponse の署名を検証するための IDP の証明書データのプロトコル。

フィールド
x509_certificate

string

x509 証明書

InboundSamlConfig

プロジェクトが証明書利用者として機能する場合に、SAML RP-IDP 構成のペアを保存するためのプロト。

フィールド
name

string

InboundSamlConfig リソースの名前（例: projects/my-awesome-project/inboundSamlConfigs/my-config-id）。作成リクエストでは無視されます。
idp_config

IdpConfig

プロジェクトが証明書利用者として機能する場合に SAML IdP（ID プロバイダ）構成を保存するためのプロト。
sp_config

SpConfig

プロジェクトがリレーリング パーティとして機能し、SAML ID プロバイダによって発行された認証アサーションを受信して承認する場合に、SAML SP（サービス プロバイダ）構成を保存するためのプロトコル。
display_name

string

デベロッパーが設定した構成の表示名。
enabled

bool

ユーザーがプロバイダでログインできるようにする場合は true。

IdpConfig

プロジェクトが証明書利用者として機能する場合に SAML IdP（ID プロバイダ）構成を保存するためのプロト。

フィールド
idp_entity_id

string

すべての SAML エンティティの一意の識別子。
sso_url

string

認証リクエストを送信する URL。
idp_certificates[]

IdpCertificate

アサーションの署名を検証するための IDP の公開鍵。
sign_request

bool

アウトバウンド SAMLRequest に署名する必要があるかどうかを示します。

SpConfig

プロジェクトがリレーリング パーティとして機能し、SAML ID プロバイダによって発行された認証アサーションを受信して承認する場合に、SAML SP（サービス プロバイダ）構成を保存するためのプロトコル。

フィールド
sp_entity_id

string

すべての SAML エンティティの一意の識別子。
callback_uri

string

IDP からのレスポンスが処理されるコールバック URI。
sp_certificates[]

SpCertificate

出力専用。SP が開始したフローで SAMLRequest の署名を検証するためにサーバーが生成した公開証明書。

ListDefaultSupportedIdpConfigsRequest

ListDefaultSupportedIdpConfigs のリクエスト

フィールド
parent

string

親リソース名（例: projects/my-awesome-project）。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • firebaseauth.configs.get
page_size

int32

返す最大アイテム数。
page_token

string

前の List リクエストから返された next_page_token 値（存在する場合）。

ListDefaultSupportedIdpConfigsResponse

ListDefaultSupportedIdpConfigs のレスポンス

フィールド
default_supported_idp_configs[]

DefaultSupportedIdpConfig

構成のセット。
next_page_token

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

ListDefaultSupportedIdpsRequest

ListDefaultSupportedIdps のリクエスト

フィールド
page_size

int32

返す最大アイテム数。
page_token

string

前の List リクエストから返された next_page_token 値（存在する場合）。

ListDefaultSupportedIdpsResponse

ListDefaultSupportedIdps のレスポンス

フィールド
default_supported_idps[]

DefaultSupportedIdp

構成のセット。
next_page_token

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

ListInboundSamlConfigsRequest

ListInboundSamlConfigs のリクエスト

フィールド
parent

string

親リソース名（例: projects/my-awesome-project）。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • firebaseauth.configs.get
page_size

int32

返す最大アイテム数。
page_token

string

前の List リクエストから返された next_page_token 値（存在する場合）。

ListInboundSamlConfigsResponse

ListInboundSamlConfigs のレスポンス

フィールド
inbound_saml_configs[]

InboundSamlConfig

構成のセット。
next_page_token

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

ListOAuthIdpConfigsRequest

ListOAuthIdpConfigs のリクエスト

フィールド
parent

string

親リソース名（例: projects/my-awesome-project）。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • firebaseauth.configs.get
page_size

int32

返す最大アイテム数。
page_token

string

前の List リクエストから返された next_page_token 値（存在する場合）。

ListOAuthIdpConfigsResponse

ListOAuthIdpConfigs のレスポンス

フィールド
oauth_idp_configs[]

OAuthIdpConfig

構成のセット。
next_page_token

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

ListTenantsRequest

ListTenants に対するリクエスト メッセージです。

フィールド
parent

string

必須。テナントを一覧表示する親リソース名。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • identitytoolkit.tenants.list
page_token

string

前のリクエストのレスポンスのページ設定トークン。
page_size

int32

返される結果の最大数（上限は 1, 000）。指定しない場合、デフォルト値は 20 です。

ListTenantsResponse

ListTenants に対するレスポンス メッセージです。

フィールド
tenants[]

Tenant

指定されたエージェント プロジェクトのテナントのリスト。
next_page_token

string

結果の次のページを取得するためのトークン。

MonitoringConfig

プロジェクト アクティビティのモニタリングに関連する構成。

フィールド
request_logging

RequestLogging

このプロジェクトに対して行われたリクエストを Stackdriver Logging にロギングするための構成

RequestLogging

このプロジェクトに対して行われたリクエストを Stackdriver Logging にロギングするための構成

フィールド
enabled

bool

このプロジェクトでロギングが有効かどうか。

MultiFactorAuthConfig

プロジェクトの多要素認証に関連するオプション。

フィールド
state

State

このプロジェクトで多要素認証が有効になっているかどうか。
enabled_providers[]

Provider

このプロジェクトで使用可能な第 2 要素のリスト。

プロバイダ

このプロジェクトで使用可能な第 2 要素のリスト。

列挙型
PROVIDER_UNSPECIFIED 違法なプロバイダ。使用しないでください
PHONE_SMS このプロジェクトでは SMS が第 2 要素として有効になっています。

州

このプロジェクトで多要素認証が有効になっているかどうか。

列挙型
STATE_UNSPECIFIED 不正な状態。使用しないでください。
DISABLED このプロジェクトでは多要素認証を使用できません
ENABLED このプロジェクトで多要素認証を使用できる
ADMIN_ENABLED このプロジェクトでは多要素認証を使用できますが、プロジェクト管理者のみ設定できます

NotificationConfig

ユーザーへの通知の送信に関連する設定。

フィールド
send_email

SendEmail

メール送信のオプション。
send_sms

SendSms

SMS 送信のオプション。
default_locale

string

メールと SMS に使用されるデフォルトのロケール（IETF BCP 47 形式）。

SendEmail

メール送信のオプション。

フィールド
method

Method

メールの送信に使用される方法。
reset_password_template

EmailTemplate

パスワードの再設定用のメール テンプレート
verify_email_template

EmailTemplate

メール確認用のメール テンプレート
change_email_template

EmailTemplate

変更メールのメール テンプレート
legacy_reset_password_template

EmailTemplate

以前の Firebase V1 アプリのパスワード再設定メール テンプレート。
callback_uri

string

メール テンプレートのアクション URL。
dns_info

DnsInfo

カスタム ドメインの DNS 確認に関する情報。
共用体フィールド email_provider_config。メールの送信に使用されるメール プロバイダの構成 email_provider_config は、次のいずれかになります。
smtp

Smtp

カスタム SMTP リレーを使用する

DnsInfo

カスタム ドメインの DNS 確認に関する情報。デフォルトでは、default_domain が使用されます。カスタム ドメインは VerifyCustomDomain を使用して構成できます。

フィールド
custom_domain

string

出力専用。適用された確認済みのカスタム ドメイン。
use_custom_domain

bool

カスタム ドメインを使用するかどうか。
pending_custom_domain

string

出力専用。所有権を確認するカスタム ドメイン。
custom_domain_state

VerificationState

出力専用。カスタム ドメインの現在の確認ステータス。カスタム ドメインは、ドメインの所有権が確認された場合にのみ使用されます。
domain_verification_request_time

Timestamp

出力専用。現在のドメイン確認の最初のリクエストのタイムスタンプ。

VerificationState

カスタム ドメインの現在の所有権証明ステータス。

列挙型
VERIFICATION_STATE_UNSPECIFIED デフォルト値。使用しないでください。
NOT_STARTED 確認は開始されていません。
IN_PROGRESS 確認中です。
FAILED 確認に失敗しました。
SUCCEEDED 確認が完了し、適用できる状態になりました。

EmailTemplate

メール テンプレート。件名と本文のフィールドには、適切な値に置き換えられる次のプレースホルダを含めることができます。%LINK% - 送信 OOB コードの利用に使用するリンク。%EMAIL% - メールの送信先のメールアドレス。%NEW_EMAIL% - アカウントに設定される新しいメールアドレス（該当する場合）。%APP_NAME% - Google Cloud プロジェクトの表示名。%DISPLAY_NAME% - ユーザーの表示名。

フィールド
sender_local_part

string

送信元アドレスのローカル部分
subject

string

メールの件名
sender_display_name

string

送信者の表示名
body

string

メールの本文
body_format

BodyFormat

メール本文の形式
reply_to

string

返信先アドレス
customized

bool

出力専用。メールの本文または件名がカスタマイズされているかどうか。

BodyFormat

メール本文の形式

列挙型
BODY_FORMAT_UNSPECIFIED デフォルト値。使用しないでください。
PLAIN_TEXT 書式なしテキスト
HTML HTML

メソッド

メールの送信に使用される方法。

列挙型
METHOD_UNSPECIFIED メール方法が指定されていません。
DEFAULT デベロッパーに代わってメールを送信する。
CUSTOM_SMTP デベロッパーが提供する SMTP 構成を使用してメールを送信する。

Smtp

SMTP リレーの構成

フィールド
sender_email

string

SMTP リレーの送信者メール
host

string

SMTP リレーホスト
port

int32

SMTP リレー ポート
username

string

SMTP リレーのユーザー名
password

string

SMTP リレーのパスワード
security_mode

SecurityMode

SMTP セキュリティ モード。

SecurityMode

SMTP セキュリティ モード。

列挙型
SECURITY_MODE_UNSPECIFIED デフォルト値。使用しないでください。
SSL SSL モード
START_TLS START_TLS モード

SendSms

SMS 送信のオプション。

フィールド
use_device_locale

bool

SMS に accept_language ヘッダーを使用するかどうか。
sms_template

SmsTemplate

出力専用。SMS の送信時に使用するテンプレート。

SmsTemplate

SMS の送信時に使用するテンプレート。

フィールド
content

string

出力専用。SMS の内容。次のプレースホルダを含めることができます。これらのプレースホルダは、適切な値に置き換えられます。%APP_NAME% - Android アプリまたは iOS アプリの場合、アプリの表示名。ウェブアプリの場合は、アプリケーションをホストしているドメイン。%LOGIN_CODE% - SMS で送信される OOB コード。

OAuthIdpConfig

OAuth IdP で認証するための構成オプション。

フィールド
name

string

OAuthIdpConfig リソースの名前（例: projects/my-awesome-project/oauthIdpConfigs/oauth-config-id）。作成リクエストでは無視されます。
client_id

string

OAuth クライアントのクライアント ID。
issuer

string

OIDC Idp の場合は、発行元 ID。
display_name

string

デベロッパーが設定した構成の表示名。
enabled

bool

ユーザーがプロバイダでログインできるようにする場合は true。
client_secret

string

OIDC コードフローを有効にするための OAuth クライアントのクライアント シークレット。
response_type

OAuthResponseType

OAuth 認証フロー内でリクエストするレスポンス タイプ。id_token または code のいずれかを true に設定できますが、両方は設定できません。両方のタイプを同時に true（{code: true, id_token: true}）に設定することはまだサポートされていません。

OAuthResponseType

OAuth 認証フロー内でリクエストするレスポンス タイプ。id_token または code のいずれかを true に設定できますが、両方は設定できません。両方のタイプを同時に true（{code: true, id_token: true}）に設定することはまだサポートされていません。

レスポンス タイプと OAuth 2.0 フローのマッピングについては、https://openid.net/specs/openid-connect-core-1_0.html#Authentication をご覧ください。

フィールド
id_token

bool

true の場合、IdP の認可エンドポイントから ID トークンが返されます。
code

bool

true の場合、IdP の認可エンドポイントから認可コードが返されます。
token
(deprecated)

bool

使用しないでください。token レスポンス タイプは現在サポートされていません。

QuotaConfig

割り当てに関連する構成。

フィールド
sign_up_quota_config

TemporaryQuota

登録エンドポイントの割り当て（上書きされている場合）。登録クォータは、プロジェクト、IP、1 時間あたりの登録数で測定されます。

TemporaryQuota

一時的な割り当ての増減

フィールド
quota

int64

QuotaServer 構成の refill_token_count フィールドに対応します。
start_time

Timestamp

この割り当てが有効になる日時
quota_duration

Duration

この割り当ての有効期間

SignInConfig

ローカル ログイン方法に関連する構成。

フィールド
email

Email

メールアドレスによるユーザー認証に関連する構成オプション。
phone_number

PhoneNumber

電話番号によるユーザーの認証に関連する構成オプション。
anonymous

Anonymous

匿名ユーザーの認証に関連する構成オプション。
allow_duplicate_emails

bool

複数のアカウントで同じメールアドレスを使用できるようにするかどうか。
hash_config

HashConfig

出力専用。ハッシュ構成情報。

匿名

匿名ユーザーの認証に関連する構成オプション。

フィールド
enabled

bool

プロジェクトで匿名ユーザー認証が有効になっているかどうか。

メール

メールアドレスによるユーザー認証に関連する構成オプション。

フィールド
enabled

bool

プロジェクトでメール認証が有効かどうか。
password_required

bool

メール認証にパスワードが必要かどうか。true の場合、ログインするにはメールアドレスとパスワードの両方を指定する必要があります。false の場合、ユーザーはメールアドレス/パスワードまたはメールリンクのいずれかを使用してログインできます。
hash_config

HashConfig

出力専用。ハッシュ構成情報。

PhoneNumber

電話番号によるユーザーの認証に関連する構成オプション。

フィールド
enabled

bool

プロジェクトで電話番号認証が有効になっているかどうか。
test_phone_numbers

map<string, string>

電話認証のテストに使用できる <テスト用電話番号、偽のコード> のマップ。

SpCertificate

IdP が SP によって生成された SAMLRequest を検証するための SP の証明書データの proto。

フィールド
x509_certificate

string

自己署名公開証明書。
expires_at

Timestamp

証明書の有効期限切れインスタンスのタイムスタンプ。

テナント

Tenant には、マルチテナント プロジェクトのテナントの構成が含まれます。

フィールド
name

string

テナントのリソース名。例: "projects/project1/tenants/tenant1"
display_name

string

テナントの表示名。
saml_configs[]
(deprecated)

SamlConfig

リクエストされた SAML 構成。
idp_configs[]
(deprecated)

IdpConfig

IDP 構成がリクエストされました。
allow_password_signup

bool

メールアドレスとパスワードによる登録を許可するかどうか。
disable_auth

bool

テナントの認証が無効になっているかどうか。無効になったテナント内のユーザーはログインできません。無効になったテナントの管理者は、そのテナントのユーザーを管理できません。

UpdateConfigRequest

UpdateConfig のリクエスト

フィールド
config

Config

サーバー上のリソースを置き換える config リソース。

認可には、指定されたリソース config に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update
update_mask

FieldMask

リソースに適用される更新マスク。構成で設定されているが、この更新マスクに含まれていないフィールドは無視されます。FieldMask の定義については、https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask をご覧ください。

UpdateDefaultSupportedIdpConfigRequest

UpdateDefaultSupportedIdpConfig のリクエスト

フィールド
default_supported_idp_config

DefaultSupportedIdpConfig

サーバー上のリソースを置き換える config リソース。

認可には、指定されたリソース defaultSupportedIdpConfig に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update
update_mask

FieldMask

リソースに適用される更新マスク。FieldMask の定義については、https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask をご覧ください。

UpdateInboundSamlConfigRequest

UpdateInboundSamlConfig のリクエスト

フィールド
inbound_saml_config

InboundSamlConfig

サーバー上のリソースを置き換える config リソース。

認可には、指定されたリソース inboundSamlConfig に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update
update_mask

FieldMask

リソースに適用される更新マスク。更新マスクが空の場合、何も更新されません。FieldMask の定義については、https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask をご覧ください。

UpdateOAuthIdpConfigRequest

UpdateOAuthIdpConfig のリクエスト

フィールド
oauth_idp_config

OAuthIdpConfig

サーバー上のリソースを置き換える config リソース。

認可には、指定されたリソース oauthIdpConfig に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update
update_mask

FieldMask

リソースに適用される更新マスク。更新マスクが空の場合、何も更新されません。FieldMask の定義については、https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask をご覧ください。

UpdateTenantRequest

UpdateTenant に対するリクエスト メッセージです。

フィールド
tenant

Tenant

必須。更新するテナント。

認可には、指定されたリソース tenant に対する次の IAM の権限が必要です。

  • identitytoolkit.tenants.update
update_mask

FieldMask

リソースに適用される更新マスク。FieldMask の定義については、https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask をご覧ください。

VerifyDomainRequest

リクエストされたカスタム ドメインに必要な DNS レコードがあることを確認するためのリクエスト メッセージ。

フィールド
resource

string

ドメインの所有権を確認するリソースの名前。現在、このメソッドでは、プロジェクト（例: projects/my-awesome-project）またはテナント（例: projects/my-awesome-project/tenants/my-awesome-tenant）のいずれかのドメインの確認が可能です。

認可には、指定されたリソース resource に対する次の IAM の権限が必要です。

  • firebaseauth.configs.update
domain

string

このリクエストのターゲット ドメイン。
action

DomainVerificationAction

特定のドメインで試行されているアクション。

DomainVerificationAction

特定のドメインで試行されているアクション。

列挙型
DOMAIN_VERIFICATION_ACTION_UNSPECIFIED デフォルト値。使用しないでください。
VERIFY リクエスト内のドメインを確認します。
CANCEL 現在の確認プロセスをキャンセルします。
APPLY メール送信にカスタム ドメインを適用します。

VerifyDomainResponse

VerifyDomain リクエストのレスポンス。

フィールド
verification_state

VerificationState

このリクエストが処理された後の、指定されたドメインの状態。
verification_error

string

該当する場合は、ドメインの所有権の確認が有効になっていなかった理由をテキストで説明します。