firebase-tools
Version:
Command-Line Interface for Firebase
958 lines (957 loc) • 447 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = {
openapi: "3.0.3",
info: {
title: "Identity Toolkit API",
description: "The Google Identity Toolkit API lets you use open standards to verify a user's identity.",
contact: { name: "Google", url: "https://google.com" },
version: "v1",
license: {
name: "Creative Commons Attribution 3.0",
url: "http://creativecommons.org/licenses/by/3.0/",
},
termsOfService: "https://developers.google.com/terms/",
},
servers: [{ url: "https://identitytoolkit.googleapis.com" }],
externalDocs: { url: "https://cloud.google.com/identity-platform" },
tags: [
{ name: "accounts" },
{ name: "projects" },
{ name: "v1" },
{ name: "defaultSupportedIdps" },
{ name: "v2" },
{ name: "secureToken" },
{ name: "emulator" },
],
paths: {
"/v1/accounts:createAuthUri": {
post: {
description: "If an email identifier is specified, checks and returns if any user account is registered with the email. If there is a registered account, fetches all providers associated with the account's email. If the provider ID of an Identity Provider (IdP) is specified, creates an authorization URI for the IdP. The user can be directed to this URI to sign in with the IdP. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.createAuthUri",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateAuthUriResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateAuthUriRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:delete": {
post: {
description: "Deletes a user's account.",
operationId: "identitytoolkit.accounts.delete",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DeleteAccountResponse",
},
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1DeleteAccountRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:issueSamlResponse": {
post: {
description: "Experimental",
operationId: "identitytoolkit.accounts.issueSamlResponse",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:lookup": {
post: {
description: "Gets account information for all matched accounts. For an end user request, retrieves the account of the end user. For an admin request with Google OAuth 2.0 credential, retrieves one or multiple account(s) with matching criteria.",
operationId: "identitytoolkit.accounts.lookup",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetAccountInfoResponse",
},
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetAccountInfoRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:resetPassword": {
post: {
description: "Resets the password of an account either using an out-of-band code generated by sendOobCode or by specifying the email and password of the account to be modified. Can also check the purpose of an out-of-band code without consuming it.",
operationId: "identitytoolkit.accounts.resetPassword",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ResetPasswordResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1ResetPasswordRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:sendOobCode": {
post: {
description: "Sends an out-of-band confirmation code for an account. Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.",
operationId: "identitytoolkit.accounts.sendOobCode",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1GetOobCodeResponse",
},
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1GetOobCodeRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:sendVerificationCode": {
post: {
description: "Sends a SMS verification code for phone number sign-in. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.sendVerificationCode",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithCustomToken": {
post: {
description: "Signs in or signs up a user by exchanging a custom Auth token. Upon a successful sign-in or sign-up, a new Identity Platform ID token and refresh token are issued for the user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signInWithCustomToken",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithEmailLink": {
post: {
description: "Signs in or signs up a user with a out-of-band code from an email link. If a user does not exist with the given email address, a user record will be created. If the sign-in succeeds, an Identity Platform ID and refresh token are issued for the authenticated user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signInWithEmailLink",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithGameCenter": {
post: {
description: "Signs in or signs up a user with iOS Game Center credentials. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project. Apple has [deprecated the `playerID` field](https://developer.apple.com/documentation/gamekit/gkplayer/1521127-playerid/). The Apple platform Firebase SDK will use `gamePlayerID` and `teamPlayerID` from version 10.5.0 and onwards. Upgrading to SDK version 10.5.0 or later updates existing integrations that use `playerID` to instead use `gamePlayerID` and `teamPlayerID`. When making calls to `signInWithGameCenter`, you must include `playerID` along with the new fields `gamePlayerID` and `teamPlayerID` to successfully identify all existing users. Upgrading existing Game Center sign in integrations to SDK version 10.5.0 or later is irreversible.",
operationId: "identitytoolkit.accounts.signInWithGameCenter",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithIdp": {
post: {
description: 'Signs in or signs up a user using credentials from an Identity Provider (IdP). This is done by manually providing an IdP credential, or by providing the authorization response obtained via the authorization request from CreateAuthUri. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. A new Identity Platform user account will be created if the user has not previously signed in to the IdP with the same account. In addition, when the "One account per email address" setting is enabled, there should not be an existing Identity Platform user account with the same email address for a new user account to be created. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.',
operationId: "identitytoolkit.accounts.signInWithIdp",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithIdpResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithIdpRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithPassword": {
post: {
description: "Signs in a user with email and password. If the sign-in succeeds, a new Identity Platform ID token and refresh token are issued for the authenticated user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signInWithPassword",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signInWithPhoneNumber": {
post: {
description: "Completes a phone number authentication attempt. If a user already exists with the given phone number, an ID token is minted for that user. Otherwise, a new user is created and associated with the phone number. This method may also be used to link a phone number to an existing user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signInWithPhoneNumber",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:signUp": {
post: {
description: "Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control), creates a new anonymous, email and password, or phone number user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.signUp",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignUpResponse" },
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SignUpRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:update": {
post: {
description: "Updates account-related information for the specified user by setting specific fields or applying action codes. Requests from administrators and end users are supported.",
operationId: "identitytoolkit.accounts.update",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SetAccountInfoResponse",
},
},
},
},
},
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SetAccountInfoRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/accounts:verifyIosClient": {
post: {
description: "Verifies an iOS client is a real iOS device. If the request is valid, a receipt will be sent in the response and a secret will be sent via Apple Push Notification Service. The client should send both of them back to certain Identity Platform APIs in a later call (for example, /accounts:sendVerificationCode), in order to verify the client. The bundle ID is required in the request header as `x-ios-bundle-identifier`. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.accounts.verifyIosClient",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1VerifyIosClientResponse",
},
},
},
},
},
requestBody: {
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1VerifyIosClientRequest",
},
},
},
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["accounts"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}/accounts": {
post: {
description: "Signs up a new email and password user or anonymous user, or upgrades an anonymous user to email and password. For an admin request with a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control), creates a new anonymous, email and password, or phone number user. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.",
operationId: "identitytoolkit.projects.accounts",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: { $ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1SignUpResponse" },
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description: "The project ID of the project which the user should belong to. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). If this is not set, the target project is inferred from the scope associated to the Bearer access token.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1SignUpRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}:createSessionCookie": {
post: {
description: "Creates a session cookie for the given Identity Platform ID token. The session cookie is used by the client to preserve the user's login state.",
operationId: "identitytoolkit.projects.createSessionCookie",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description: "The ID of the project that the account belongs to.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}:queryAccounts": {
post: {
description: "Looks up user accounts within a project or a tenant based on conditions in the request.",
operationId: "identitytoolkit.projects.queryAccounts",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1QueryUserInfoResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description: "The ID of the project to which the result is scoped.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1QueryUserInfoRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ Oauth2: ["https://www.googleapis.com/auth/firebase"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}/accounts:batchCreate": {
post: {
description: "Uploads multiple accounts into the Google Cloud project. If there is a problem uploading one or more of the accounts, the rest will be uploaded, and a list of the errors will be returned. To use this method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).",
operationId: "identitytoolkit.projects.accounts.batchCreate",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1UploadAccountResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description: "The Project ID of the Identity Platform project which the account belongs to.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1UploadAccountRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ Oauth2: ["https://www.googleapis.com/auth/firebase"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}/accounts:batchDelete": {
post: {
description: "Batch deletes multiple accounts. For accounts that fail to be deleted, error info is contained in the response. The method ignores accounts that do not exist or are duplicated in the request. This method requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).",
operationId: "identitytoolkit.projects.accounts.batchDelete",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description: "If `tenant_id` is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that accounts belong to.",
required: true,
schema: { type: "string" },
},
],
requestBody: {
$ref: "#/components/requestBodies/GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest",
},
security: [
{ Oauth2: ["https://www.googleapis.com/auth/cloud-platform"] },
{ Oauth2: ["https://www.googleapis.com/auth/firebase"] },
{ apiKeyQuery: [] },
{ apiKeyHeader: [] },
],
tags: ["projects"],
},
parameters: [
{ $ref: "#/components/parameters/access_token" },
{ $ref: "#/components/parameters/alt" },
{ $ref: "#/components/parameters/callback" },
{ $ref: "#/components/parameters/fields" },
{ $ref: "#/components/parameters/oauth_token" },
{ $ref: "#/components/parameters/prettyPrint" },
{ $ref: "#/components/parameters/quotaUser" },
{ $ref: "#/components/parameters/uploadType" },
{ $ref: "#/components/parameters/upload_protocol" },
],
},
"/v1/projects/{targetProjectId}/accounts:batchGet": {
get: {
description: "Download account information for all accounts on the project in a paginated manner. To use this method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).. Furthermore, additional permissions are needed to get password hash, password salt, and password version from accounts; otherwise these fields are redacted.",
operationId: "identitytoolkit.projects.accounts.batchGet",
responses: {
"200": {
description: "Successful response",
content: {
"*/*": {
schema: {
$ref: "#/components/schemas/GoogleCloudIdentitytoolkitV1DownloadAccountResponse",
},
},
},
},
},
parameters: [
{
name: "targetProjectId",
in: "path",
description: "If `tenant_id` is specified, the ID of the Google Cloud project that the Identity Platform tenant belongs to. Otherwise, the ID of the Google Cloud project that the accounts belong to.",
required: true,