Method: getProjects

プロジェクトの公開 Identity Toolkit 構成を取得します。（従来版）このメソッドは、非公開の構成を取得するためのデベロッパーからの認証済み呼び出しもサポートしています。

HTTP リクエスト

GET https://identitytoolkit.googleapis.com/v1/projects

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

クエリ パラメータ

パラメータ
delegatedProjectNumber

string (int64 format)

委任されたプロジェクト リクエストのプロジェクト番号。このフィールドは、Firebase V1 の移行の一環としてのみ使用してください。
projectNumber

string (int64 format)

取得する構成のプロジェクト番号。このフィールドは非推奨です。新しい統合では使用しないでください。
androidPackageName

string

実際の Android パッケージ名と照合する Android パッケージ名。このフィールドが指定され、sha1_cert_hash が指定されていない場合、これが実際の Android パッケージ名と一致しない場合、アクションはエラーをスローします。
iosBundleId

string

実際の iOS バンドル ID と照合する iOS バンドル ID。このフィールドが指定されている場合、実際の iOS バンドル ID と一致しない場合、アクションはエラーをスローします。
clientId

string

RP OAuth クライアント ID。設定されている場合、OAuth クライアントが取得したプロジェクトに対して有効であることを確認するチェックが行われ、有効でない場合、リクエストはクライアント エラーで拒否されます。
sha1Cert

string

SHA-1 Android アプリケーション証明書ハッシュ。設定されている場合、取得したプロジェクトと androidPackageName に対して証明書ハッシュが有効であることを確認するチェックが実行されます。
firebaseAppId

string

Firebase アプリ ID（Firebase を使用するアプリの場合）。これは、プロジェクトの Firebase コンソールで確認できます。設定されている場合、取得したプロジェクトに対してアプリ ID が有効であることを確認するチェックが行われます。有効でない場合、リクエストはクライアント エラーで拒否されます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

v1.getProjects のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "projectId": string,
  "apiKey": string,
  "allowPasswordUser": boolean,
  "idpConfig": [
    {
      object (IdpConfig)
    }
  ],
  "authorizedDomains": [
    string
  ],
  "enableAnonymousUser": boolean,
  "dynamicLinksDomain": string,
  "useEmailSending": boolean,
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  }
}
フィールド
projectId

string

取得した構成のプロジェクト ID。
apiKey

string

Google Cloud API キー。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
allowPasswordUser

boolean

パスワード アカウントの登録を許可するかどうか。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
idpConfig[]

object (IdpConfig)

OAuth2 プロバイダの構成。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
authorizedDomains[]

string

ウィジェット リダイレクトの承認済みドメイン。
enableAnonymousUser

boolean

匿名ユーザーが有効かどうか。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
useEmailSending

boolean

メール送信を使用するかどうか。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
resetPasswordTemplate

object (EmailTemplate)

パスワードのリセット用のメール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
verifyEmailTemplate

object (EmailTemplate)

メール確認用のメール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
changeEmailTemplate

object (EmailTemplate)

メールアドレス変更用のメール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
legacyResetPasswordTemplate

object (EmailTemplate)

以前の Firebase V1 アプリのパスワード再設定メール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。
revertSecondFactorAdditionTemplate

object (EmailTemplate)

第 2 要素の追加を元に戻すためのメール テンプレート。このフィールドは、デベロッパーからの認証済み呼び出しでのみ返されます。

認可スコープ

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

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

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

IdpConfig

ID プロバイダの構成。

JSON 表現 
{
  "provider": enum (Provider),
  "enabled": boolean,
  "experimentPercent": integer,
  "clientId": string,
  "secret": string,
  "whitelistedAudiences": [
    string
  ]
}
フィールド
provider

enum (Provider)
enabled

boolean

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

integer

この IdP の連携ログインを求められる/リダイレクトされるユーザーの割合
clientId

string

OAuth2 クライアント ID。
secret

string

OAuth2 クライアント シークレット。
whitelistedAudiences[]

string

オーディエンス チェックのホワイトリストに登録されたクライアント ID。

プロバイダ

ID プロバイダの名前。

列挙型
PROVIDER_UNSPECIFIED
MSLIVE ID プロバイダとして Microsoft Live。
GOOGLE ID プロバイダとして Google を使用。
FACEBOOK ID プロバイダとして Facebook を使用します。
PAYPAL ID プロバイダとして PayPal を使用。
TWITTER ID プロバイダとしての Twitter。
YAHOO ID プロバイダとして Yahoo。
AOL ID プロバイダとして AOL を使用。
GITHUB ID プロバイダとしての GitHub。
GOOGLE_PLAY_GAMES ID プロバイダとして Google Play Games を使用する。
LINKEDIN ID プロバイダとして LinkedIn を使用。
IOS_GAME_CENTER ID プロバイダとして iOS Game Center を使用する。

EmailTemplate

メール テンプレート

JSON 表現 
{
  "disabled": boolean,
  "from": string,
  "body": string,
  "subject": string,
  "fromDisplayName": string,
  "format": enum (EmailBodyFormat),
  "replyTo": string,
  "fromLocalPart": string,
  "locale": string,
  "customized": boolean
}
フィールド
disabled

boolean

テンプレートが無効かどうか。true の場合、デフォルトのテンプレートが使用されます。
from

string

メールの送信元アドレス
body

string

メールの本文
subject

string

メールの件名
fromDisplayName

string

表示名から
format

enum (EmailBodyFormat)

メール本文の形式
replyTo

string

返信先アドレス
fromLocalPart

string

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

string

値は III 言語コード形式です（例: zh-CN、es）。区切り文字には「-」と「_」の両方を使用できます。
customized

boolean

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

EmailBodyFormat

メール本文の形式

列挙型
EMAIL_BODY_FORMAT_UNSPECIFIED デフォルト値。使用しないでください。
PLAINTEXT メール本文は書式なしテキスト形式です。
HTML メールの本文は HTML 形式です。