{ "baseUrl": "https://identitytoolkit.googleapis.com/", "ownerDomain": "google.com", "name": "identitytoolkit", "resources": { "accounts": { "methods": { "lookup": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/accounts:lookup", "flatPath": "v1/accounts:lookup", "request": { "$ref": "GoogleCloudIdentitytoolkitV1GetAccountInfoRequest" }, "parameters": {}, "parameterOrder": [], "id": "identitytoolkit.accounts.lookup", "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.", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetAccountInfoResponse" } }, "sendVerificationCode": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse" }, "path": "v1/accounts:sendVerificationCode", "flatPath": "v1/accounts:sendVerificationCode", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sends a SMS verification code for phone number sign-in. To localize the text of the SMS sent to the user, set the HTTP header `X-Firebase-Locale` to the language code that corresponds with the user's locale. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.", "id": "identitytoolkit.accounts.sendVerificationCode", "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest" } }, "verifyIosClient": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1VerifyIosClientResponse" }, "httpMethod": "POST", "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1VerifyIosClientRequest" }, "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.", "id": "identitytoolkit.accounts.verifyIosClient", "path": "v1/accounts:verifyIosClient", "flatPath": "v1/accounts:verifyIosClient", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "signInWithPassword": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest" }, "parameters": {}, "parameterOrder": [], "id": "identitytoolkit.accounts.signInWithPassword", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/accounts:signInWithPassword", "flatPath": "v1/accounts:signInWithPassword" }, "signInWithGameCenter": { "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.", "id": "identitytoolkit.accounts.signInWithGameCenter", "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest" }, "path": "v1/accounts:signInWithGameCenter", "flatPath": "v1/accounts:signInWithGameCenter", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse" }, "httpMethod": "POST" }, "resetPassword": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/accounts:resetPassword", "flatPath": "v1/accounts:resetPassword", "id": "identitytoolkit.accounts.resetPassword", "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.", "request": { "$ref": "GoogleCloudIdentitytoolkitV1ResetPasswordRequest" }, "parameters": {}, "parameterOrder": [], "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1ResetPasswordResponse" } }, "update": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1SetAccountInfoResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/accounts:update", "flatPath": "v1/accounts:update", "request": { "$ref": "GoogleCloudIdentitytoolkitV1SetAccountInfoRequest" }, "parameters": {}, "parameterOrder": [], "id": "identitytoolkit.accounts.update", "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." }, "signInWithCustomToken": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse" }, "httpMethod": "POST", "id": "identitytoolkit.accounts.signInWithCustomToken", "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.", "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest" }, "parameters": {}, "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/accounts:signInWithCustomToken", "flatPath": "v1/accounts:signInWithCustomToken" }, "signInWithEmailLink": { "path": "v1/accounts:signInWithEmailLink", "flatPath": "v1/accounts:signInWithEmailLink", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest" }, "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.", "id": "identitytoolkit.accounts.signInWithEmailLink", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse" } }, "signInWithPhoneNumber": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse" }, "httpMethod": "POST", "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest" }, "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. To localize the text of the SMS sent to the user, set the HTTP header `X-Firebase-Locale` to the language code that corresponds with the user's locale. An [API key](https://cloud.google.com/docs/authentication/api-keys) is required in the request in order to identify the Google Cloud project.", "id": "identitytoolkit.accounts.signInWithPhoneNumber", "path": "v1/accounts:signInWithPhoneNumber", "flatPath": "v1/accounts:signInWithPhoneNumber", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "signUp": { "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignUpRequest" }, "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.", "id": "identitytoolkit.accounts.signUp", "path": "v1/accounts:signUp", "flatPath": "v1/accounts:signUp", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignUpResponse" }, "httpMethod": "POST" }, "issueSamlResponse": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/accounts:issueSamlResponse", "flatPath": "v1/accounts:issueSamlResponse", "id": "identitytoolkit.accounts.issueSamlResponse", "description": "Experimental", "request": { "$ref": "GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest" }, "parameters": {}, "parameterOrder": [] }, "delete": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1DeleteAccountResponse" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudIdentitytoolkitV1DeleteAccountRequest" }, "parameters": {}, "parameterOrder": [], "id": "identitytoolkit.accounts.delete", "description": "Deletes a user's account.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/accounts:delete", "flatPath": "v1/accounts:delete" }, "sendOobCode": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetOobCodeResponse" }, "httpMethod": "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.", "id": "identitytoolkit.accounts.sendOobCode", "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1GetOobCodeRequest" }, "path": "v1/accounts:sendOobCode", "flatPath": "v1/accounts:sendOobCode", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "createAuthUri": { "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 [email enumeration protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, this method returns an empty list. 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.", "id": "identitytoolkit.accounts.createAuthUri", "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1CreateAuthUriRequest" }, "path": "v1/accounts:createAuthUri", "flatPath": "v1/accounts:createAuthUri", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1CreateAuthUriResponse" }, "httpMethod": "POST" }, "signInWithIdp": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithIdpResponse" }, "httpMethod": "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.", "id": "identitytoolkit.accounts.signInWithIdp", "parameters": {}, "parameterOrder": [], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignInWithIdpRequest" }, "path": "v1/accounts:signInWithIdp", "flatPath": "v1/accounts:signInWithIdp", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "v1": { "methods": { "getProjects": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetProjectConfigResponse" }, "httpMethod": "GET", "parameters": { "returnDynamicLink": { "description": "Whether dynamic link should be returned.", "location": "query", "type": "boolean" }, "sha1Cert": { "type": "string", "location": "query", "description": "SHA-1 Android application cert hash. If set, a check will be performed to ensure that the cert hash is valid for the retrieved project and android_package_name." }, "iosBundleId": { "location": "query", "description": "iOS bundle id to check against the real ios bundle id. If this field is provided, the action will throw an error if this does not match the real iOS bundle id.", "type": "string" }, "delegatedProjectNumber": { "location": "query", "description": "Project Number of the delegated project request. This field should only be used as part of the Firebase V1 migration.", "format": "int64", "type": "string" }, "firebaseAppId": { "location": "query", "description": "The Firebase app ID, for applications that use Firebase. This can be found in the Firebase console for your project. If set, a check will be performed to ensure that the app ID is valid for the retrieved project. If not valid, the request will be rejected with a client error.", "type": "string" }, "clientId": { "location": "query", "description": "The RP OAuth client ID. If set, a check will be performed to ensure that the OAuth client is valid for the retrieved project and the request rejected with a client error if not valid.", "type": "string" }, "projectNumber": { "location": "query", "description": "Project number of the configuration to retrieve. This field is deprecated and should not be used by new integrations.", "format": "int64", "type": "string" }, "androidPackageName": { "type": "string", "description": "Android package name to check against the real android package name. If this field is provided, and sha1_cert_hash is not provided, the action will throw an error if this does not match the real android package name.", "location": "query" } }, "parameterOrder": [], "description": "Gets a project's public Identity Toolkit configuration. (Legacy) This method also supports authenticated calls from a developer to retrieve non-public configuration.", "id": "identitytoolkit.getProjects", "path": "v1/projects", "flatPath": "v1/projects", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "getSessionCookiePublicKeys": { "path": "v1/sessionCookiePublicKeys", "flatPath": "v1/sessionCookiePublicKeys", "httpMethod": "GET", "id": "identitytoolkit.getSessionCookiePublicKeys", "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetSessionCookiePublicKeysResponse" }, "description": "Retrieves the set of public keys of the session cookie JSON Web Token (JWT) signer that can be used to validate the session cookie created through createSessionCookie.", "parameters": {}, "parameterOrder": [] }, "getPublicKeys": { "httpMethod": "GET", "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/publicKeys", "flatPath": "v1/publicKeys", "parameters": {}, "parameterOrder": [], "id": "identitytoolkit.getPublicKeys", "description": "Retrieves public keys of the legacy Identity Toolkit token signer to enable third parties to verify the legacy ID token. For now the X509 pem cert is the only format supported." }, "getRecaptchaParams": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/recaptchaParams", "flatPath": "v1/recaptchaParams", "parameters": {}, "parameterOrder": [], "id": "identitytoolkit.getRecaptchaParams", "description": "Gets parameters needed for generating a reCAPTCHA challenge." } } }, "projects": { "methods": { "queryAccounts": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1QueryUserInfoResponse" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudIdentitytoolkitV1QueryUserInfoRequest" }, "parameters": { "targetProjectId": { "description": "The ID of the project to which the result is scoped.", "location": "path", "required": true, "pattern": "^[^/]+$", "type": "string" } }, "parameterOrder": [ "targetProjectId" ], "id": "identitytoolkit.projects.queryAccounts", "description": "Looks up user accounts within a project or a tenant based on conditions in the request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "path": "v1/projects/{+targetProjectId}:queryAccounts", "flatPath": "v1/projects/{projectsId}:queryAccounts" }, "createSessionCookie": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse" }, "httpMethod": "POST", "request": { "$ref": "GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest" }, "parameters": { "targetProjectId": { "location": "path", "description": "The ID of the project that the account belongs to.", "required": true, "pattern": "^[^/]+$", "type": "string" } }, "parameterOrder": [ "targetProjectId" ], "id": "identitytoolkit.projects.createSessionCookie", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/projects/{+targetProjectId}:createSessionCookie", "flatPath": "v1/projects/{projectsId}:createSessionCookie" }, "accounts": { "id": "identitytoolkit.projects.accounts", "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.", "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignUpRequest" }, "parameters": { "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "location": "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 } }, "parameterOrder": [ "targetProjectId" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/projects/{+targetProjectId}/accounts", "flatPath": "v1/projects/{projectsId}/accounts", "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignUpResponse" }, "httpMethod": "POST" } }, "resources": { "accounts": { "methods": { "batchGet": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudIdentitytoolkitV1DownloadAccountResponse" }, "path": "v1/projects/{+targetProjectId}/accounts:batchGet", "flatPath": "v1/projects/{projectsId}/accounts:batchGet", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "parameters": { "maxResults": { "description": "The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.", "format": "int32", "location": "query", "type": "integer" }, "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "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.", "location": "path", "required": true }, "delegatedProjectNumber": { "location": "query", "format": "int64", "deprecated": true, "type": "string" }, "nextPageToken": { "type": "string", "location": "query", "description": "The pagination token from the response of a previous request." }, "tenantId": { "type": "string", "description": "The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.", "location": "query" } }, "parameterOrder": [ "targetProjectId" ], "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.", "id": "identitytoolkit.projects.accounts.batchGet" }, "lookup": { "path": "v1/projects/{+targetProjectId}/accounts:lookup", "flatPath": "v1/projects/{projectsId}/accounts:lookup", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "id": "identitytoolkit.projects.accounts.lookup", "parameters": { "targetProjectId": { "location": "path", "description": "The ID of the Google Cloud project that the account or the Identity Platform tenant specified by `tenant_id` belongs to. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "required": true, "pattern": "^[^/]+$", "type": "string" } }, "parameterOrder": [ "targetProjectId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1GetAccountInfoRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetAccountInfoResponse" } }, "batchCreate": { "parameters": { "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "description": "The Project ID of the Identity Platform project which the account belongs to.", "location": "path", "required": true } }, "parameterOrder": [ "targetProjectId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1UploadAccountRequest" }, "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).", "id": "identitytoolkit.projects.accounts.batchCreate", "path": "v1/projects/{+targetProjectId}/accounts:batchCreate", "flatPath": "v1/projects/{projectsId}/accounts:batchCreate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1UploadAccountResponse" }, "httpMethod": "POST" }, "batchDelete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "path": "v1/projects/{+targetProjectId}/accounts:batchDelete", "flatPath": "v1/projects/{projectsId}/accounts:batchDelete", "id": "identitytoolkit.projects.accounts.batchDelete", "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).", "request": { "$ref": "GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest" }, "parameters": { "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "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.", "location": "path", "required": true } }, "parameterOrder": [ "targetProjectId" ], "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse" } }, "sendOobCode": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetOobCodeResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/projects/{+targetProjectId}/accounts:sendOobCode", "flatPath": "v1/projects/{projectsId}/accounts:sendOobCode", "request": { "$ref": "GoogleCloudIdentitytoolkitV1GetOobCodeRequest" }, "parameters": { "targetProjectId": { "type": "string", "pattern": "^[^/]+$", "required": true, "description": "The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "location": "path" } }, "parameterOrder": [ "targetProjectId" ], "id": "identitytoolkit.projects.accounts.sendOobCode", "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." }, "delete": { "parameters": { "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "description": "The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify local_id of an account.", "location": "path", "required": true } }, "parameterOrder": [ "targetProjectId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1DeleteAccountRequest" }, "description": "Deletes a user's account.", "id": "identitytoolkit.projects.accounts.delete", "path": "v1/projects/{+targetProjectId}/accounts:delete", "flatPath": "v1/projects/{projectsId}/accounts:delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1DeleteAccountResponse" }, "httpMethod": "POST" }, "update": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1SetAccountInfoResponse" }, "httpMethod": "POST", "parameters": { "targetProjectId": { "required": true, "description": "The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). Requests from end users should pass an Identity Platform ID token instead.", "location": "path", "type": "string", "pattern": "^[^/]+$" } }, "parameterOrder": [ "targetProjectId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SetAccountInfoRequest" }, "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.", "id": "identitytoolkit.projects.accounts.update", "path": "v1/projects/{+targetProjectId}/accounts:update", "flatPath": "v1/projects/{projectsId}/accounts:update", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "query": { "description": "Looks up user accounts within a project or a tenant based on conditions in the request.", "id": "identitytoolkit.projects.accounts.query", "parameters": { "targetProjectId": { "description": "The ID of the project to which the result is scoped.", "location": "path", "required": true, "pattern": "^[^/]+$", "type": "string" } }, "parameterOrder": [ "targetProjectId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1QueryUserInfoRequest" }, "path": "v1/projects/{+targetProjectId}/accounts:query", "flatPath": "v1/projects/{projectsId}/accounts:query", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1QueryUserInfoResponse" }, "httpMethod": "POST" } } }, "tenants": { "methods": { "createSessionCookie": { "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.", "id": "identitytoolkit.projects.tenants.createSessionCookie", "parameters": { "targetProjectId": { "required": true, "location": "path", "description": "The ID of the project that the account belongs to.", "type": "string", "pattern": "^[^/]+$" }, "tenantId": { "pattern": "^[^/]+$", "type": "string", "location": "path", "description": "The tenant ID of the Identity Platform tenant the account belongs to.", "required": true } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest" }, "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}:createSessionCookie", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}:createSessionCookie", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse" }, "httpMethod": "POST" }, "accounts": { "parameters": { "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "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.", "location": "path", "required": true }, "tenantId": { "type": "string", "pattern": "^[^/]+$", "required": true, "description": "The ID of the Identity Platform tenant to create a user under. If not set, the user will be created under the default Identity Platform project.", "location": "path" } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SignUpRequest" }, "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.", "id": "identitytoolkit.projects.tenants.accounts", "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1SignUpResponse" }, "httpMethod": "POST" } }, "resources": { "accounts": { "methods": { "query": { "request": { "$ref": "GoogleCloudIdentitytoolkitV1QueryUserInfoRequest" }, "parameters": { "targetProjectId": { "location": "path", "description": "The ID of the project to which the result is scoped.", "required": true, "pattern": "^[^/]+$", "type": "string" }, "tenantId": { "description": "The ID of the tenant to which the result is scoped.", "location": "path", "required": true, "pattern": "^[^/]+$", "type": "string" } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "id": "identitytoolkit.projects.tenants.accounts.query", "description": "Looks up user accounts within a project or a tenant based on conditions in the request.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:query", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts:query", "response": { "$ref": "GoogleCloudIdentitytoolkitV1QueryUserInfoResponse" }, "httpMethod": "POST" }, "batchGet": { "httpMethod": "GET", "response": { "$ref": "GoogleCloudIdentitytoolkitV1DownloadAccountResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:batchGet", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts:batchGet", "parameters": { "maxResults": { "location": "query", "description": "The maximum number of results to return. Must be at least 1 and no greater than 1000. By default, it is 20.", "format": "int32", "type": "integer" }, "targetProjectId": { "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.", "location": "path", "required": true, "pattern": "^[^/]+$", "type": "string" }, "delegatedProjectNumber": { "location": "query", "format": "int64", "deprecated": true, "type": "string" }, "nextPageToken": { "type": "string", "location": "query", "description": "The pagination token from the response of a previous request." }, "tenantId": { "type": "string", "pattern": "^[^/]+$", "required": true, "description": "The ID of the Identity Platform tenant the accounts belongs to. If not specified, accounts on the Identity Platform project are returned.", "location": "path" } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "id": "identitytoolkit.projects.tenants.accounts.batchGet", "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." }, "lookup": { "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:lookup", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts:lookup", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "id": "identitytoolkit.projects.tenants.accounts.lookup", "parameters": { "targetProjectId": { "required": true, "location": "path", "description": "The ID of the Google Cloud project that the account or the Identity Platform tenant specified by `tenant_id` belongs to. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "type": "string", "pattern": "^[^/]+$" }, "tenantId": { "required": true, "location": "path", "description": "The ID of the tenant that the account belongs to. Should only be specified by authenticated requests from a developer.", "type": "string", "pattern": "^[^/]+$" } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1GetAccountInfoRequest" }, "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetAccountInfoResponse" } }, "batchCreate": { "response": { "$ref": "GoogleCloudIdentitytoolkitV1UploadAccountResponse" }, "httpMethod": "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).", "id": "identitytoolkit.projects.tenants.accounts.batchCreate", "parameters": { "targetProjectId": { "type": "string", "pattern": "^[^/]+$", "required": true, "location": "path", "description": "The Project ID of the Identity Platform project which the account belongs to." }, "tenantId": { "type": "string", "pattern": "^[^/]+$", "required": true, "description": "The ID of the Identity Platform tenant the account belongs to.", "location": "path" } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1UploadAccountRequest" }, "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:batchCreate", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts:batchCreate", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ] }, "batchDelete": { "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).", "id": "identitytoolkit.projects.tenants.accounts.batchDelete", "parameters": { "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "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.", "location": "path", "required": true }, "tenantId": { "location": "path", "description": "If the accounts belong to an Identity Platform tenant, the ID of the tenant. If the accounts belong to a default Identity Platform project, the field is not needed.", "required": true, "pattern": "^[^/]+$", "type": "string" } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest" }, "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:batchDelete", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts:batchDelete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/firebase" ], "response": { "$ref": "GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse" }, "httpMethod": "POST" }, "sendOobCode": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1GetOobCodeResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:sendOobCode", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts:sendOobCode", "id": "identitytoolkit.projects.tenants.accounts.sendOobCode", "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.", "request": { "$ref": "GoogleCloudIdentitytoolkitV1GetOobCodeRequest" }, "parameters": { "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "description": "The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "location": "path", "required": true }, "tenantId": { "pattern": "^[^/]+$", "type": "string", "description": "The tenant ID of the Identity Platform tenant the account belongs to.", "location": "path", "required": true } }, "parameterOrder": [ "targetProjectId", "tenantId" ] }, "delete": { "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1DeleteAccountResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:delete", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts:delete", "request": { "$ref": "GoogleCloudIdentitytoolkitV1DeleteAccountRequest" }, "parameters": { "targetProjectId": { "required": true, "location": "path", "description": "The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify local_id of an account.", "type": "string", "pattern": "^[^/]+$" }, "tenantId": { "type": "string", "pattern": "^[^/]+$", "required": true, "description": "The ID of the tenant that the account belongs to, if applicable. Only require to be specified for authenticated requests bearing a Google OAuth 2.0 credential that specify local_id of an account that belongs to an Identity Platform tenant.", "location": "path" } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "id": "identitytoolkit.projects.tenants.accounts.delete", "description": "Deletes a user's account." }, "update": { "path": "v1/projects/{+targetProjectId}/tenants/{+tenantId}/accounts:update", "flatPath": "v1/projects/{projectsId}/tenants/{tenantsId}/accounts:update", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "targetProjectId": { "pattern": "^[^/]+$", "type": "string", "location": "path", "description": "The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). Requests from end users should pass an Identity Platform ID token instead.", "required": true }, "tenantId": { "required": true, "description": "The tenant ID of the Identity Platform tenant that the account belongs to. Requests from end users should pass an Identity Platform ID token rather than setting this field.", "location": "path", "type": "string", "pattern": "^[^/]+$" } }, "parameterOrder": [ "targetProjectId", "tenantId" ], "request": { "$ref": "GoogleCloudIdentitytoolkitV1SetAccountInfoRequest" }, "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.", "id": "identitytoolkit.projects.tenants.accounts.update", "httpMethod": "POST", "response": { "$ref": "GoogleCloudIdentitytoolkitV1SetAccountInfoResponse" } } } } } } } } }, "protocol": "rest", "id": "identitytoolkit:v1", "kind": "discovery#restDescription", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "schemas": { "GoogleCloudIdentitytoolkitV1SignUpRequest": { "description": "Request message for SignUp.", "id": "GoogleCloudIdentitytoolkitV1SignUpRequest", "type": "object", "properties": { "password": { "description": "The password to assign to the created user. The password must be be at least 6 characters long. If set, the `email` field must also be set.", "type": "string" }, "photoUrl": { "description": "The profile photo url of the user to create.", "type": "string" }, "clientType": { "description": "The client type: web, Android or iOS. Required when enabling reCAPTCHA enterprise protection.", "enum": [ "CLIENT_TYPE_UNSPECIFIED", "CLIENT_TYPE_WEB", "CLIENT_TYPE_ANDROID", "CLIENT_TYPE_IOS" ], "type": "string", "enumDescriptions": [ "Client type is not specified.", "Client type is web.", "Client type is android.", "Client type is ios." ] }, "captchaChallenge": { "deprecated": true, "type": "string" }, "phoneNumber": { "description": "The phone number of the user to create. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "type": "string" }, "captchaResponse": { "description": "The reCAPTCHA token provided by the reCAPTCHA client-side integration. reCAPTCHA Enterprise uses it for assessment. Required when reCAPTCHA enterprise is enabled.", "type": "string" }, "emailVerified": { "description": "Whether the user's email is verified. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "type": "boolean" }, "disabled": { "description": "Whether the user will be disabled upon creation. Disabled accounts are inaccessible except for requests bearing a Google OAuth2 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "type": "boolean" }, "instanceId": { "deprecated": true, "type": "string" }, "tenantId": { "description": "The ID of the Identity Platform tenant to create a user under. If not set, the user will be created under the default Identity Platform project.", "type": "string" }, "mfaInfo": { "type": "array", "description": "The multi-factor authentication providers for the user to create.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1MfaFactor" } }, "localId": { "description": "The ID of the user to create. The ID must be unique within the project that the user is being created under. Specifying this field requires a Google OAuth 2.0 credential with the proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "type": "string" }, "displayName": { "description": "The display name of the user to be created.", "type": "string" }, "idToken": { "description": "A valid ID token for an Identity Platform user. If set, this request will link the authentication credential to the user represented by this ID token. For a non-admin request, both the `email` and `password` fields must be set. For an admin request, `local_id` must not be set.", "type": "string" }, "email": { "description": "The email to assign to the created user. The length of the email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. An anonymous user will be created if not provided.", "type": "string" }, "recaptchaVersion": { "type": "string", "enumDescriptions": [ "The reCAPTCHA version is not specified.", "The reCAPTCHA enterprise." ], "description": "The reCAPTCHA version of the reCAPTCHA token in the captcha_response.", "enum": [ "RECAPTCHA_VERSION_UNSPECIFIED", "RECAPTCHA_ENTERPRISE" ] }, "targetProjectId": { "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.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1GetSessionCookiePublicKeysResponse": { "properties": { "keys": { "description": "Public keys of the session cookie signer, formatted as [JSON Web Keys (JWK)](https://tools.ietf.org/html/rfc7517).", "items": { "$ref": "GoogleCloudIdentitytoolkitV1OpenIdConnectKey" }, "type": "array" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1GetSessionCookiePublicKeysResponse", "description": "Response message for GetSessionCookiePublicKeys." }, "GoogleCloudIdentitytoolkitV1UploadAccountResponse": { "description": "Response message for UploadAccount.", "id": "GoogleCloudIdentitytoolkitV1UploadAccountResponse", "type": "object", "properties": { "kind": { "deprecated": true, "type": "string" }, "error": { "type": "array", "description": "Detailed error info for accounts that cannot be uploaded.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1ErrorInfo" } } } }, "GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse": { "description": "Response message for CreateSessionCookie.", "id": "GoogleCloudIdentitytoolkitV1CreateSessionCookieResponse", "type": "object", "properties": { "sessionCookie": { "description": "The session cookie that has been created from the Identity Platform ID token specified in the request. It is in the form of a JSON Web Token (JWT). Always present.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1GetAccountInfoRequest": { "description": "Request message for GetAccountInfo.", "id": "GoogleCloudIdentitytoolkitV1GetAccountInfoRequest", "type": "object", "properties": { "tenantId": { "description": "The ID of the tenant that the account belongs to. Should only be specified by authenticated requests from a developer.", "type": "string" }, "localId": { "type": "array", "description": "The ID of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "items": { "type": "string" } }, "federatedUserId": { "type": "array", "items": { "$ref": "GoogleCloudIdentitytoolkitV1FederatedUserIdentifier" } }, "idToken": { "description": "The Identity Platform ID token of the account to fetch. Require to be specified for requests from end users.", "type": "string" }, "email": { "type": "array", "description": "The email address of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer.", "items": { "type": "string" } }, "delegatedProjectNumber": { "deprecated": true, "type": "string", "format": "int64" }, "phoneNumber": { "type": "array", "description": "The phone number of one or more accounts to fetch. Should only be specified by authenticated requests from a developer and should be in E.164 format, for example, +15555555555.", "items": { "type": "string" } }, "initialEmail": { "description": "The initial email of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer.", "items": { "type": "string" }, "type": "array" }, "targetProjectId": { "description": "The ID of the Google Cloud project that the account or the Identity Platform tenant specified by `tenant_id` belongs to. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest": { "description": "Request message for SignInWithPassword.", "id": "GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest", "type": "object", "properties": { "idToken": { "deprecated": true, "type": "string" }, "pendingIdToken": { "deprecated": true, "type": "string" }, "password": { "description": "Required. The password the user provides to sign in to the account.", "type": "string" }, "returnSecureToken": { "description": "Should always be true.", "type": "boolean" }, "tenantId": { "description": "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform instance in the project.", "type": "string" }, "clientType": { "type": "string", "enumDescriptions": [ "Client type is not specified.", "Client type is web.", "Client type is android.", "Client type is ios." ], "description": "The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.", "enum": [ "CLIENT_TYPE_UNSPECIFIED", "CLIENT_TYPE_WEB", "CLIENT_TYPE_ANDROID", "CLIENT_TYPE_IOS" ] }, "recaptchaVersion": { "description": "The reCAPTCHA version of the reCAPTCHA token in the captcha_response.", "enum": [ "RECAPTCHA_VERSION_UNSPECIFIED", "RECAPTCHA_ENTERPRISE" ], "type": "string", "enumDescriptions": [ "The reCAPTCHA version is not specified.", "The reCAPTCHA enterprise." ] }, "instanceId": { "deprecated": true, "type": "string" }, "email": { "description": "Required. The email the user is signing in with. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production.", "type": "string" }, "delegatedProjectNumber": { "format": "int64", "deprecated": true, "type": "string" }, "captchaChallenge": { "deprecated": true, "type": "string" }, "captchaResponse": { "description": "The reCAPTCHA token provided by the reCAPTCHA client-side integration. reCAPTCHA Enterprise uses it for risk assessment. Required when reCAPTCHA Enterprise is enabled.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse": { "type": "object", "properties": { "mfaInfo": { "description": "Info on which multi-factor authentication providers are enabled for the account. Present if the user needs to complete the sign-in using multi-factor authentication.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1MfaEnrollment" }, "type": "array" }, "refreshToken": { "description": "An Identity Platform refresh token for the authenticated user.", "type": "string" }, "expiresIn": { "description": "The number of seconds until the Identity Platform ID token expires.", "format": "int64", "type": "string" }, "localId": { "description": "The ID of the authenticated user. Always present in the response.", "type": "string" }, "displayName": { "description": "The user's display name stored in the account's attributes.", "type": "string" }, "idToken": { "description": "An Identity Platform ID token for the authenticated user.", "type": "string" }, "oauthExpireIn": { "deprecated": true, "type": "integer", "description": "The access token expiration time in seconds.", "format": "int32" }, "email": { "description": "The email of the authenticated user. Always present in the response.", "type": "string" }, "userNotifications": { "type": "array", "description": "Warning notifications for the user.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1UserNotification" } }, "profilePicture": { "description": "The user's profile picture stored in the account's attributes.", "type": "string" }, "oauthAccessToken": { "description": "The OAuth2 access token.", "deprecated": true, "type": "string" }, "registered": { "deprecated": true, "type": "boolean", "description": "Whether the email is for an existing account. Always true." }, "kind": { "deprecated": true, "type": "string" }, "mfaPendingCredential": { "description": "An opaque string that functions as proof that the user has successfully passed the first factor authentication.", "type": "string" }, "oauthAuthorizationCode": { "deprecated": true, "type": "string" } }, "description": "Response message for SignInWithPassword.", "id": "GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse" }, "GoogleCloudIdentitytoolkitV1FederatedUserIdentifier": { "description": "Federated user identifier at an Identity Provider.", "id": "GoogleCloudIdentitytoolkitV1FederatedUserIdentifier", "type": "object", "properties": { "rawId": { "description": "The user ID of the account at the third-party Identity Provider specified by `provider_id`.", "type": "string" }, "providerId": { "description": "The ID of supported identity providers. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1ResetPasswordResponse": { "id": "GoogleCloudIdentitytoolkitV1ResetPasswordResponse", "description": "Response message for ResetPassword.", "properties": { "kind": { "deprecated": true, "type": "string" }, "email": { "description": "The email associated with the out-of-band code that was used.", "type": "string" }, "mfaInfo": { "$ref": "GoogleCloudIdentitytoolkitV1MfaEnrollment" }, "newEmail": { "type": "string" }, "requestType": { "enum": [ "OOB_REQ_TYPE_UNSPECIFIED", "PASSWORD_RESET", "OLD_EMAIL_AGREE", "NEW_EMAIL_ACCEPT", "VERIFY_EMAIL", "RECOVER_EMAIL", "EMAIL_SIGNIN", "VERIFY_AND_CHANGE_EMAIL", "REVERT_SECOND_FACTOR_ADDITION" ], "enumDeprecated": [ false, false, true, true, false, true, false, false, true ], "enumDescriptions": [ "Oob code type is not specified.", "reset password", "", "", "verify the account's email address by sending an email", "", "sign in with email only", "This flow sends an email to the specified new email, and when applied by clicking the link in the email changes the account's email to the new email. Used when the account must have verified email at all times, such as MFA accounts.", "" ], "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1DeleteAccountResponse": { "type": "object", "properties": { "kind": { "deprecated": true, "type": "string" } }, "description": "Response message for DeleteAccount.", "id": "GoogleCloudIdentitytoolkitV1DeleteAccountResponse" }, "GoogleCloudIdentitytoolkitV1ProviderUserInfo": { "id": "GoogleCloudIdentitytoolkitV1ProviderUserInfo", "description": "Information about the user as provided by various Identity Providers.", "properties": { "screenName": { "description": "The user's screen_name at Twitter or login name at GitHub.", "type": "string" }, "displayName": { "description": "The user's display name at the Identity Provider.", "type": "string" }, "providerId": { "description": "The ID of the Identity Provider.", "type": "string" }, "photoUrl": { "description": "The user's profile photo URL at the Identity Provider.", "type": "string" }, "email": { "description": "The user's email address at the Identity Provider.", "type": "string" }, "rawId": { "description": "The user's raw identifier directly returned from Identity Provider.", "type": "string" }, "phoneNumber": { "description": "The user's phone number at the Identity Provider.", "type": "string" }, "federatedId": { "description": "The user's identifier at the Identity Provider.", "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1EmailTemplate": { "properties": { "body": { "description": "Email body", "type": "string" }, "subject": { "description": "Subject of the email", "type": "string" }, "disabled": { "description": "Whether the template is disabled. If true, a default template will be used.", "type": "boolean" }, "format": { "enumDescriptions": [ "Default value. Do not use.", "Email body is in plain text format.", "Email body is in HTML format." ], "type": "string", "enum": [ "EMAIL_BODY_FORMAT_UNSPECIFIED", "PLAINTEXT", "HTML" ], "description": "Email body format" }, "replyTo": { "description": "Reply-to address", "type": "string" }, "fromDisplayName": { "description": "From display name", "type": "string" }, "locale": { "description": "Value is in III language code format (e.g. \"zh-CN\", \"es\"). Both '-' and '_' separators are accepted.", "type": "string" }, "fromLocalPart": { "description": "Local part of From address", "type": "string" }, "from": { "description": "From address of the email", "type": "string" }, "customized": { "description": "Whether the body or subject of the email is customized.", "type": "boolean" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1EmailTemplate", "description": "Email template" }, "GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest": { "type": "object", "properties": { "oobCode": { "description": "Required. The out-of-band code from the email link.", "type": "string" }, "idToken": { "description": "A valid ID token for an Identity Platform account. If passed, this request will link the email address to the user represented by this ID token and enable sign-in with email link on the account for the future.", "type": "string" }, "tenantId": { "description": "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.", "type": "string" }, "email": { "description": "Required. The email address the sign-in link was sent to. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production.", "type": "string" } }, "description": "Request message for SignInWithEmailLink", "id": "GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest" }, "GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse": { "id": "GoogleCloudIdentitytoolkitV1IssueSamlResponseResponse", "description": "Response for IssueSamlResponse request.", "properties": { "firstName": { "description": "First name of the user.", "type": "string" }, "samlResponse": { "description": "Signed SAMLResponse created for the Relying Party.", "type": "string" }, "acsEndpoint": { "description": "The ACS endpoint which consumes the returned SAMLResponse.", "type": "string" }, "relayState": { "description": "Generated RelayState.", "type": "string" }, "isNewUser": { "description": "Whether the logged in user was created by this request.", "type": "boolean" }, "email": { "description": "Email of the user.", "type": "string" }, "lastName": { "description": "Last name of the user.", "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse": { "id": "GoogleCloudIdentitytoolkitV1SignInWithCustomTokenResponse", "description": "Response message for SignInWithCustomToken.", "properties": { "idToken": { "description": "An Identity Platform ID token for the authenticated user.", "type": "string" }, "isNewUser": { "description": "Whether the authenticated user was created by this request.", "type": "boolean" }, "kind": { "deprecated": true, "type": "string" }, "refreshToken": { "description": "An Identity Platform refresh token for the authenticated user.", "type": "string" }, "expiresIn": { "type": "string", "description": "The number of seconds until the ID token expires.", "format": "int64" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1VerifyIosClientResponse": { "properties": { "receipt": { "description": "Receipt of successful app token validation.", "type": "string" }, "suggestedTimeout": { "type": "string", "description": "Suggested time that the client should wait in seconds for delivery of the push notification.", "format": "int64" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1VerifyIosClientResponse", "description": "Response message for VerifyIosClient." }, "GoogleCloudIdentitytoolkitV1IdpConfig": { "id": "GoogleCloudIdentitytoolkitV1IdpConfig", "description": "Config of an identity provider.", "properties": { "provider": { "enum": [ "PROVIDER_UNSPECIFIED", "MSLIVE", "GOOGLE", "FACEBOOK", "PAYPAL", "TWITTER", "YAHOO", "AOL", "GITHUB", "GOOGLE_PLAY_GAMES", "LINKEDIN", "IOS_GAME_CENTER" ], "enumDescriptions": [ "", "Microsoft Live as identity provider.", "Google as identity provider.", "Facebook as identity provider.", "PayPal as identity provider.", "Twitter as identity provider.", "Yahoo as identity provider.", "AOL as identity provider.", "GitHub as identity provider.", "Google Play Games as identity provider.", "LinkedIn as identity provider.", "iOS Game Center as identity provider." ], "type": "string" }, "enabled": { "description": "True if allows the user to sign in with the provider.", "type": "boolean" }, "whitelistedAudiences": { "description": "Whitelisted client IDs for audience check.", "items": { "type": "string" }, "type": "array" }, "secret": { "description": "OAuth2 client secret.", "type": "string" }, "experimentPercent": { "description": "Percent of users who will be prompted/redirected federated login for this IdP", "format": "int32", "type": "integer" }, "clientId": { "description": "OAuth2 client ID.", "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest": { "id": "GoogleCloudIdentitytoolkitV1SignInWithCustomTokenRequest", "description": "Request message for SignInWithCustomToken.", "properties": { "instanceId": { "deprecated": true, "type": "string" }, "returnSecureToken": { "description": "Should always be true.", "type": "boolean" }, "delegatedProjectNumber": { "format": "int64", "deprecated": true, "type": "string" }, "token": { "description": "Required. The custom Auth token asserted by the developer. The token should be a [JSON Web Token (JWT)](https://tools.ietf.org/html/rfc7519) that includes the claims listed in the [API reference](https://cloud.google.com/identity-platform/docs/reference/rest/client/) under the \"Custom Token Claims\" section.", "type": "string" }, "tenantId": { "description": "The ID of the Identity Platform tenant the user is signing in to. If present, the ID should match the tenant_id in the token.", "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1SetAccountInfoRequest": { "description": "Request message for SetAccountInfo.", "id": "GoogleCloudIdentitytoolkitV1SetAccountInfoRequest", "type": "object", "properties": { "captchaResponse": { "description": "The response from reCaptcha challenge. This is required when the system detects possible abuse activities.", "type": "string" }, "password": { "description": "The user's new password to be updated in the account's attributes. The password must be at least 6 characters long.", "type": "string" }, "photoUrl": { "description": "The user's new photo URL for the account's profile photo to be updated in the account's attributes. The length of the URL must be less than or equal to 2048 characters.", "type": "string" }, "returnSecureToken": { "description": "Whether or not to return an ID and refresh token. Should always be true.", "type": "boolean" }, "email": { "description": "The user's new email to be updated in the account's attributes. The length of email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. If [email enumeration protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, the email cannot be changed by the user without verifying the email first, but it can be changed by an administrator.", "type": "string" }, "targetProjectId": { "description": "The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). Requests from end users should pass an Identity Platform ID token instead.", "type": "string" }, "localId": { "description": "The ID of the user. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control). For requests from end-users, an ID token should be passed instead.", "type": "string" }, "idToken": { "description": "A valid Identity Platform ID token. Required when attempting to change user-related information.", "type": "string" }, "displayName": { "description": "The user's new display name to be updated in the account's attributes. The length of the display name must be less than or equal to 256 characters.", "type": "string" }, "validSince": { "type": "string", "description": "Specifies the minimum timestamp in seconds for an Identity Platform ID token to be considered valid.", "format": "int64" }, "captchaChallenge": { "deprecated": true, "type": "string" }, "lastLoginAt": { "description": "The timestamp in milliseconds when the account last logged in.", "format": "int64", "type": "string" }, "delegatedProjectNumber": { "deprecated": true, "type": "string", "format": "int64" }, "emailVerified": { "description": "Whether the user's email has been verified. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).", "type": "boolean" }, "deleteProvider": { "type": "array", "description": "The Identity Providers to unlink from the user's account.", "items": { "type": "string" } }, "disableUser": { "description": "If true, marks the account as disabled, meaning the user will no longer be able to sign-in.", "type": "boolean" }, "phoneNumber": { "description": "The phone number to be updated in the account's attributes.", "type": "string" }, "deleteAttribute": { "type": "array", "items": { "type": "string", "enumDescriptions": [ "User attribute name is not specified.", "User attribute key name is email.", "User attribute key name is displayName.", "User attribute key name is provider.", "User attribute key name is photoURL.", "User attribute key name is password.", "User attribute key name is rawUserInfo." ], "enum": [ "USER_ATTRIBUTE_NAME_UNSPECIFIED", "EMAIL", "DISPLAY_NAME", "PROVIDER", "PHOTO_URL", "PASSWORD", "RAW_USER_INFO" ] } }, "linkProviderUserInfo": { "description": "The provider to be linked to the user's account. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).", "$ref": "GoogleCloudIdentitytoolkitV1ProviderUserInfo" }, "instanceId": { "deprecated": true, "type": "string" }, "mfa": { "description": "The multi-factor authentication related information to be set on the user's account. This will overwrite any previous multi-factor related information on the account. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).", "$ref": "GoogleCloudIdentitytoolkitV1MfaInfo" }, "customAttributes": { "description": "JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).", "type": "string" }, "oobCode": { "description": "The out-of-band code to be applied on the user's account. The following out-of-band code types are supported: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL", "type": "string" }, "upgradeToFederatedLogin": { "description": "Whether the account should be restricted to only using federated login.", "type": "boolean" }, "tenantId": { "description": "The tenant ID of the Identity Platform tenant that the account belongs to. Requests from end users should pass an Identity Platform ID token rather than setting this field.", "type": "string" }, "createdAt": { "description": "The timestamp in milliseconds when the account was created.", "format": "int64", "type": "string" }, "provider": { "type": "array", "description": "The Identity Providers that the account should be associated with.", "items": { "type": "string" } } } }, "GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse": { "id": "GoogleCloudIdentitytoolkitV1GetRecaptchaParamResponse", "description": "Response message for GetRecaptchaParam.", "properties": { "kind": { "deprecated": true, "type": "string" }, "recaptchaSiteKey": { "description": "The reCAPTCHA v2 site key used to invoke the reCAPTCHA service. Always present.", "type": "string" }, "producerProjectNumber": { "description": "The producer project number used to generate PIA tokens", "type": "string" }, "recaptchaStoken": { "deprecated": true, "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest": { "type": "object", "properties": { "localIds": { "type": "array", "description": "Required. List of user IDs to be deleted.", "items": { "type": "string" } }, "force": { "description": "Whether to force deleting accounts that are not in disabled state. If false, only disabled accounts will be deleted, and accounts that are not disabled will be added to the `errors`.", "type": "boolean" }, "tenantId": { "description": "If the accounts belong to an Identity Platform tenant, the ID of the tenant. If the accounts belong to a default Identity Platform project, the field is not needed.", "type": "string" } }, "description": "Request message for BatchDeleteAccounts.", "id": "GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest" }, "GoogleCloudIdentitytoolkitV1VerifyIosClientRequest": { "id": "GoogleCloudIdentitytoolkitV1VerifyIosClientRequest", "description": "Request message for VerifyIosClient", "properties": { "appToken": { "description": "A device token that the iOS client gets after registering to APNs (Apple Push Notification service).", "type": "string" }, "isSandbox": { "description": "Whether the app token is in the iOS sandbox. If false, the app token is in the production environment.", "type": "boolean" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1CreateAuthUriResponse": { "type": "object", "properties": { "providerId": { "description": "The provider ID from the request, if provided.", "type": "string" }, "sessionId": { "description": "The session ID from the request, or a random string generated by CreateAuthUri if absent. It is used to prevent session fixation attacks.", "type": "string" }, "kind": { "deprecated": true, "type": "string" }, "signinMethods": { "type": "array", "description": "The list of sign-in methods that the user has previously used. Each element is one of `password`, `emailLink`, or the provider ID of an IdP. Present only when a registered email identifier is set in the request. If [email enumeration protection](https://cloud.google.com/identity-platform/docs/admin/email-enumeration-protection) is enabled, this method returns an empty list.", "items": { "type": "string" } }, "captchaRequired": { "description": "Whether a CAPTCHA is needed because there have been too many failed login attempts by the user. Present only when a registered email identifier is set in the request.", "type": "boolean" }, "registered": { "description": "Whether the email identifier represents an existing account. Present only when an email identifier is set in the request.", "type": "boolean" }, "allProviders": { "items": { "type": "string" }, "deprecated": true, "type": "array" }, "authUri": { "description": "The authorization URI for the requested provider. Present only when a provider ID is set in the request.", "type": "string" }, "forExistingProvider": { "description": "Whether the user has previously signed in with the provider ID in the request. Present only when a registered email identifier is set in the request.", "type": "boolean" } }, "description": "Response message for CreateAuthUri.", "id": "GoogleCloudIdentitytoolkitV1CreateAuthUriResponse" }, "GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest": { "description": "Request message for CreateSessionCookie.", "id": "GoogleCloudIdentitytoolkitV1CreateSessionCookieRequest", "type": "object", "properties": { "idToken": { "description": "Required. A valid Identity Platform ID token.", "type": "string" }, "validDuration": { "description": "The number of seconds until the session cookie expires. Specify a duration in seconds, between five minutes and fourteen days, inclusively.", "format": "int64", "type": "string" }, "tenantId": { "description": "The tenant ID of the Identity Platform tenant the account belongs to.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1MfaInfo": { "description": "Multi-factor authentication related information.", "id": "GoogleCloudIdentitytoolkitV1MfaInfo", "type": "object", "properties": { "enrollments": { "type": "array", "description": "The second factors the user has enrolled.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1MfaEnrollment" } } } }, "GoogleCloudIdentitytoolkitV1GetProjectConfigResponse": { "type": "object", "properties": { "revertSecondFactorAdditionTemplate": { "description": "Email template for reverting second factor additions. This field is only returned for authenticated calls from a developer.", "$ref": "GoogleCloudIdentitytoolkitV1EmailTemplate" }, "dynamicLinksDomain": { "description": "The Firebase Dynamic Links domain used to construct links for redirects to native apps.", "type": "string" }, "allowPasswordUser": { "description": "Whether to allow password account sign up. This field is only returned for authenticated calls from a developer.", "type": "boolean" }, "resetPasswordTemplate": { "description": "Email template for reset password. This field is only returned for authenticated calls from a developer.", "$ref": "GoogleCloudIdentitytoolkitV1EmailTemplate" }, "verifyEmailTemplate": { "description": "Email template for verify email. This field is only returned for authenticated calls from a developer.", "$ref": "GoogleCloudIdentitytoolkitV1EmailTemplate" }, "apiKey": { "description": "Google Cloud API key. This field is only returned for authenticated calls from a developer.", "type": "string" }, "authorizedDomains": { "description": "Authorized domains for widget redirect.", "items": { "type": "string" }, "type": "array" }, "legacyResetPasswordTemplate": { "description": "Reset password email template for legacy Firebase V1 app. This field is only returned for authenticated calls from a developer.", "$ref": "GoogleCloudIdentitytoolkitV1EmailTemplate" }, "idpConfig": { "type": "array", "description": "OAuth2 provider config. This field is only returned for authenticated calls from a developer.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1IdpConfig" } }, "enableAnonymousUser": { "description": "Whether anonymous user is enabled. This field is only returned for authenticated calls from a developer.", "type": "boolean" }, "projectId": { "description": "The project id of the retrieved configuration.", "type": "string" }, "useEmailSending": { "description": "Whether to use email sending. This field is only returned for authenticated calls from a developer.", "type": "boolean" }, "changeEmailTemplate": { "description": "Email template for change email. This field is only returned for authenticated calls from a developer.", "$ref": "GoogleCloudIdentitytoolkitV1EmailTemplate" } }, "description": "Response message for GetProjectConfig.", "id": "GoogleCloudIdentitytoolkitV1GetProjectConfigResponse" }, "GoogleCloudIdentitytoolkitV1Argon2Parameters": { "properties": { "version": { "description": "The version of the Argon2 algorithm. This defaults to VERSION_13 if not specified.", "enum": [ "VERSION_UNSPECIFIED", "VERSION_10", "VERSION_13" ], "type": "string", "enumDescriptions": [ "The version is not specified.", "The previous version, 0x10.", "The current version, 0x13. The default value for version." ] }, "hashType": { "enumDescriptions": [ "The hash type is not specified.", "An Argon2 variant, Argon2d.", "An Argon2 variant, Argonid. Recommended.", "An Argon2 variant, Argon2i." ], "type": "string", "enum": [ "HASH_TYPE_UNSPECIFIED", "ARGON2_D", "ARGON2_ID", "ARGON2_I" ], "description": "Required. Must not be HASH_TYPE_UNSPECIFIED." }, "parallelism": { "description": "Required. The degree of parallelism, also called threads or lanes. Minimum is 1, maximum is 16.", "format": "int32", "type": "integer" }, "iterations": { "description": "Required. The number of iterations to perform. Minimum is 1, maximum is 16.", "format": "int32", "type": "integer" }, "associatedData": { "description": "The additional associated data, if provided, is appended to the hash value to provide an additional layer of security. A base64-encoded string if specified via JSON.", "format": "byte", "type": "string" }, "hashLengthBytes": { "description": "Required. The desired hash length in bytes. Minimum is 4 and maximum is 1024.", "format": "int32", "type": "integer" }, "memoryCostKib": { "type": "integer", "description": "Required. The memory cost in kibibytes. Maximum is 32768.", "format": "int32" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1Argon2Parameters", "description": "The parameters for Argon2 hashing algorithm." }, "GoogleCloudIdentitytoolkitV1ErrorInfo": { "type": "object", "properties": { "index": { "type": "integer", "description": "The index of the item, range is [0, request.size - 1]", "format": "int32" }, "message": { "description": "Detailed error message", "type": "string" } }, "description": "Error information explaining why an account cannot be uploaded. batch upload.", "id": "GoogleCloudIdentitytoolkitV1ErrorInfo" }, "GoogleCloudIdentitytoolkitV1QueryUserInfoResponse": { "id": "GoogleCloudIdentitytoolkitV1QueryUserInfoResponse", "description": "Response message for QueryUserInfo.", "properties": { "userInfo": { "description": "If `return_user_info` in the request is true, this is the accounts matching the query.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1UserInfo" }, "type": "array" }, "recordsCount": { "type": "string", "description": "If `return_user_info` in the request is true, this is the number of returned accounts in this message. Otherwise, this is the total number of accounts matching the query.", "format": "int64" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1SignInWithIdpResponse": { "description": "Response message for SignInWithIdp.", "id": "GoogleCloudIdentitytoolkitV1SignInWithIdpResponse", "type": "object", "properties": { "needConfirmation": { "description": "Whether or not there is an existing Identity Platform user account with the same email address as the current account signed in at the IdP, and the account's email address is not verified at the IdP. The user will need to sign in to the existing Identity Platform account and then link the current credential from the IdP to it. Only present if the \"One account per email address\" setting is enabled.", "type": "boolean" }, "oauthAccessToken": { "description": "The OAuth access token from the IdP, if available.", "type": "string" }, "fullName": { "description": "The full name for the user's account at the IdP.", "type": "string" }, "firstName": { "description": "The first name for the user's account at the IdP.", "type": "string" }, "refreshToken": { "description": "An Identity Platform refresh token for the authenticated user.", "type": "string" }, "expiresIn": { "type": "string", "description": "The number of seconds until the Identity Platform ID token expires.", "format": "int64" }, "tenantId": { "description": "The value of the `tenant_id` field in the request.", "type": "string" }, "mfaInfo": { "description": "Info on which multi-factor authentication providers are enabled for the account. Present if the user needs to complete the sign-in using multi-factor authentication.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1MfaEnrollment" }, "type": "array" }, "providerId": { "description": "The provider ID of the IdP that the user is signing in to. Always present in the response.", "type": "string" }, "rawUserInfo": { "description": "The stringified JSON response containing all the data corresponding to the user's account at the IdP.", "type": "string" }, "oauthAuthorizationCode": { "description": "The OAuth 2.0 authorization code, if available. Only present for the Google provider.", "type": "string" }, "needEmail": { "deprecated": true, "type": "boolean" }, "emailVerified": { "description": "Whether the user account's email address is verified.", "type": "boolean" }, "mfaPendingCredential": { "description": "An opaque string that functions as proof that the user has successfully passed the first factor authentication.", "type": "string" }, "isNewUser": { "description": "Whether or not a new Identity Platform account was created for the authenticated user.", "type": "boolean" }, "errorMessage": { "description": "The error message returned if `return_idp_credential` is set to `true` and either the `FEDERATED_USER_ID_ALREADY_LINKED` or `EMAIL_EXISTS` error is encountered. This field's value is either `FEDERATED_USER_ID_ALREADY_LINKED` or `EMAIL_EXISTS`.", "type": "string" }, "inputEmail": { "deprecated": true, "type": "string" }, "nickName": { "description": "The nickname for the user's account at the IdP.", "type": "string" }, "oauthTokenSecret": { "description": "The OAuth 1.0 token secret from the IdP, if available. Only present for the Twitter provider.", "type": "string" }, "email": { "description": "The email address of the user's account at the IdP.", "type": "string" }, "oauthExpireIn": { "description": "The number of seconds until the OAuth access token from the IdP expires.", "format": "int32", "type": "integer" }, "pendingToken": { "description": "An opaque string that can be used as a credential from the IdP the user is signing into. The pending token obtained here can be set in a future SignInWithIdp request to sign the same user in with the IdP again.", "type": "string" }, "displayName": { "description": "The display name for the user's account at the IdP.", "type": "string" }, "idToken": { "description": "An Identity Platform ID token for the authenticated user.", "type": "string" }, "localId": { "description": "The ID of the authenticated Identity Platform user. Always present in the response.", "type": "string" }, "verifiedProvider": { "type": "array", "description": "A list of provider IDs that the user can sign in to in order to resolve a `need_confirmation` error. Only present if `need_confirmation` is set to `true`.", "items": { "type": "string" } }, "emailRecycled": { "description": "Whether or not there is an existing Identity Platform user account with the same email address but linked to a different account at the same IdP. Only present if the \"One account per email address\" setting is enabled and the email address at the IdP is verified.", "type": "boolean" }, "language": { "description": "The language preference for the user's account at the IdP.", "type": "string" }, "screenName": { "description": "The screen name for the user's account at the Twitter IdP or the login name for the user's account at the GitHub IdP.", "type": "string" }, "lastName": { "description": "The last name for the user's account at the IdP.", "type": "string" }, "kind": { "deprecated": true, "type": "string" }, "context": { "description": "The opaque string set in CreateAuthUri that is used to maintain contextual information between the authentication request and the callback from the IdP.", "type": "string" }, "federatedId": { "description": "The user's account ID at the IdP. Always present in the response.", "type": "string" }, "timeZone": { "description": "The time zone for the user's account at the IdP.", "type": "string" }, "dateOfBirth": { "description": "The date of birth for the user's account at the IdP.", "type": "string" }, "oauthRefreshToken": { "description": "The OAuth 2.0 refresh token from the IdP, if available and `return_refresh_token` is set to `true`.", "type": "string" }, "oauthIdToken": { "description": "The OpenID Connect ID token from the IdP, if available.", "type": "string" }, "originalEmail": { "description": "The main (top-level) email address of the user's Identity Platform account, if different from the email address at the IdP. Only present if the \"One account per email address\" setting is enabled.", "type": "string" }, "photoUrl": { "description": "The URL of the user's profile picture at the IdP.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse": { "description": "Response message for SignInWithGameCenter", "id": "GoogleCloudIdentitytoolkitV1SignInWithGameCenterResponse", "type": "object", "properties": { "gamePlayerId": { "description": "The user's Game Center game player ID. A unique identifier for a player of the game. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid", "type": "string" }, "localId": { "description": "The ID of the authenticated user. Always present in the response.", "type": "string" }, "refreshToken": { "description": "An Identity Platform refresh token for the authenticated user.", "type": "string" }, "expiresIn": { "type": "string", "description": "The number of seconds until the ID token expires.", "format": "int64" }, "idToken": { "description": "An Identity Platform ID token for the authenticated user.", "type": "string" }, "displayName": { "description": "Display name of the authenticated user.", "type": "string" }, "isNewUser": { "description": "Whether the logged in user was created by this request.", "type": "boolean" }, "playerId": { "description": "The user's Game Center player ID. Pass `playerID` along with `gamePlayerID` and `teamPlayerID` to initiate the migration of a user's Game Center player ID to `gamePlayerID`.", "type": "string" }, "teamPlayerId": { "description": "The user's Game Center team player ID. A unique identifier for a player of all the games that you distribute using your developer account. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1SignUpResponse": { "description": "Response message for SignUp.", "id": "GoogleCloudIdentitytoolkitV1SignUpResponse", "type": "object", "properties": { "kind": { "type": "string" }, "email": { "description": "The created user's email.", "type": "string" }, "refreshToken": { "description": "An Identity Platform refresh token for the created user. This field is only set for non-admin requests.", "type": "string" }, "expiresIn": { "type": "string", "description": "The number of seconds until the ID token expires.", "format": "int64" }, "localId": { "description": "The ID of the created user. Always present in the response.", "type": "string" }, "idToken": { "description": "An Identity Platform ID token for the created user. This field is only set for non-admin requests.", "type": "string" }, "displayName": { "description": "The created user's display name.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1DownloadAccountResponse": { "type": "object", "properties": { "users": { "type": "array", "description": "All accounts belonging to the project/tenant limited by max_results in the request.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1UserInfo" } }, "kind": { "deprecated": true, "type": "string" }, "nextPageToken": { "description": "If there are more accounts to be downloaded, a token that can be passed back to DownloadAccount to get more accounts. Otherwise, this is blank.", "type": "string" } }, "description": "Response message for DownloadAccount.", "id": "GoogleCloudIdentitytoolkitV1DownloadAccountResponse" }, "GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse": { "type": "object", "properties": { "idToken": { "description": "An Identity Platform ID token for the authenticated user.", "type": "string" }, "isNewUser": { "description": "Whether the authenticated user was created by this request.", "type": "boolean" }, "mfaInfo": { "type": "array", "description": "Info on which multi-factor authentication providers are enabled. Present if the user needs to complete the sign-in using multi-factor authentication.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1MfaEnrollment" } }, "refreshToken": { "description": "Refresh token for the authenticated user.", "type": "string" }, "expiresIn": { "description": "The number of seconds until the ID token expires.", "format": "int64", "type": "string" }, "localId": { "description": "The ID of the authenticated user. Always present in the response.", "type": "string" }, "kind": { "deprecated": true, "type": "string" }, "email": { "description": "The email the user signed in with. Always present in the response.", "type": "string" }, "mfaPendingCredential": { "description": "An opaque string that functions as proof that the user has successfully passed the first factor check.", "type": "string" } }, "description": "Response message for SignInWithEmailLink.", "id": "GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse" }, "GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest": { "description": "Request message for SignInWithPhoneNumber.", "id": "GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest", "type": "object", "properties": { "code": { "description": "User-entered verification code from an SMS sent to the user's phone.", "type": "string" }, "temporaryProof": { "description": "A proof of the phone number verification, provided from a previous signInWithPhoneNumber request. If this is passed, the caller must also pass in the phone_number field the phone number that was verified in the previous request.", "type": "string" }, "idToken": { "description": "A valid ID token for an Identity Platform account. If passed, this request will link the phone number to the user represented by this ID token if the phone number is not in use, or will reauthenticate the user if the phone number is already linked to the user.", "type": "string" }, "sessionInfo": { "description": "Encrypted session information from the response of sendVerificationCode. In the case of authenticating with an SMS code this must be specified, but in the case of using a temporary proof it can be unspecified.", "type": "string" }, "phoneNumber": { "description": "The user's phone number to sign in with. This is necessary in the case of uing a temporary proof, in which case it must match the phone number that was authenticated in the request that generated the temporary proof. This field is ignored if a session info is passed.", "type": "string" }, "verificationProof": { "description": "Do not use.", "type": "string" }, "operation": { "enum": [ "VERIFY_OP_UNSPECIFIED", "SIGN_UP_OR_IN", "REAUTH", "UPDATE", "LINK" ], "enumDescriptions": [ "Operation is not specified.", "Verify operation is to sign up/sign in.", "Verify operation is to reauth.", "Verify operation is to update.", "Verify operation is to link." ], "deprecated": true, "type": "string" }, "tenantId": { "description": "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest": { "description": "Request message for IssueSamlResponse.", "id": "GoogleCloudIdentitytoolkitV1IssueSamlResponseRequest", "type": "object", "properties": { "idToken": { "description": "The Identity Platform ID token. It will be verified and then converted to a new SAMLResponse.", "type": "string" }, "samlAppEntityId": { "description": "SAML app entity id specified in Google Admin Console for each app. If developers want to redirect to a third-party app rather than a G Suite app, they'll probably they need this. When it's used, we'll return a RelayState. This includes a SAMLRequest, which can be used to trigger a SP-initiated SAML flow to redirect to the real app.", "type": "string" }, "rpId": { "description": "Relying Party identifier, which is the audience of issued SAMLResponse.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1UserInfo": { "type": "object", "properties": { "emailLinkSignin": { "type": "boolean", "readOnly": true, "description": "Output only. Whether the account can authenticate with email link." }, "lastLoginAt": { "type": "string", "description": "The last time, in milliseconds from epoch, this account was logged into.", "format": "int64" }, "phoneNumber": { "description": "The account's phone number.", "type": "string" }, "emailVerified": { "description": "Whether the account's email address has been verified.", "type": "boolean" }, "customAttributes": { "description": "Custom claims to be added to any ID tokens minted for the account. Should be at most 1,000 characters in length and in valid JSON format.", "type": "string" }, "providerUserInfo": { "type": "array", "description": "Information about the user as provided by various Identity Providers.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1ProviderUserInfo" } }, "passwordHash": { "description": "The account's hashed password. Only accessible by requests bearing a Google OAuth2 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "format": "byte", "type": "string" }, "initialEmail": { "description": "The first email address associated with this account. The account's initial email cannot be changed once set and is used to recover access to this account if lost via the RECOVER_EMAIL flow in GetOobCode. Should match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec.", "type": "string" }, "passwordUpdatedAt": { "description": "The timestamp, in milliseconds from the epoch of 1970-01-01T00:00:00Z, when the account's password was last updated.", "format": "double", "type": "number" }, "tenantId": { "description": "ID of the tenant this account belongs to. Only set if this account belongs to a tenant.", "type": "string" }, "mfaInfo": { "description": "Information on which multi-factor authentication providers are enabled for this account.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1MfaEnrollment" }, "type": "array" }, "createdAt": { "description": "The time, in milliseconds from epoch, when the account was created.", "format": "int64", "type": "string" }, "screenName": { "type": "string", "description": "Output only. This account's screen name at Twitter or login name at GitHub.", "readOnly": true }, "language": { "description": "Output only. The language preference of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.", "readOnly": true, "type": "string" }, "salt": { "type": "string", "description": "The account's password salt. Only accessible by requests bearing a Google OAuth2 credential with proper permissions.", "format": "byte" }, "disabled": { "description": "Whether the account is disabled. Disabled accounts are inaccessible except for requests bearing a Google OAuth2 credential with proper permissions.", "type": "boolean" }, "lastRefreshAt": { "description": "Timestamp when an ID token was last minted for this account.", "format": "google-datetime", "type": "string" }, "version": { "type": "integer", "description": "The version of the account's password. Only accessible by requests bearing a Google OAuth2 credential with proper permissions.", "format": "int32" }, "customAuth": { "description": "Output only. Whether this account has been authenticated using SignInWithCustomToken.", "readOnly": true, "type": "boolean" }, "photoUrl": { "description": "The URL of the account's profile photo. This account attribute is not used by Identity Platform. It is available for informational purposes only.", "type": "string" }, "timeZone": { "type": "string", "description": "Output only. The time zone preference of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.", "readOnly": true }, "dateOfBirth": { "type": "string", "description": "Output only. The date of birth set for the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.", "readOnly": true }, "email": { "description": "The account's email address. The length of the email should be less than 256 characters and in the format of `name@domain.tld`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec.", "type": "string" }, "rawPassword": { "description": "Input only. Plain text password used to update a account's password. This field is only ever used as input in a request. Identity Platform uses cryptographically secure hashing when managing passwords and will never store or transmit a user's password in plain text.", "type": "string" }, "displayName": { "description": "The display name of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only.", "type": "string" }, "validSince": { "description": "Oldest timestamp, in seconds since epoch, that an ID token should be considered valid. All ID tokens issued before this time are considered invalid.", "format": "int64", "type": "string" }, "localId": { "description": "Immutable. The unique ID of the account.", "type": "string" } }, "description": "An Identity Platform account's information.", "id": "GoogleCloudIdentitytoolkitV1UserInfo" }, "GoogleCloudIdentitytoolkitV1SqlExpression": { "description": "Query conditions used to filter results.", "id": "GoogleCloudIdentitytoolkitV1SqlExpression", "type": "object", "properties": { "email": { "description": "A case insensitive string that the account's email should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied.", "type": "string" }, "userId": { "description": "A string that the account's local ID should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression If more than one is specified, only the first (in that order) will be applied.", "type": "string" }, "phoneNumber": { "description": "A string that the account's phone number should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1GetOobCodeResponse": { "description": "Response message for GetOobCode.", "id": "GoogleCloudIdentitytoolkitV1GetOobCodeResponse", "type": "object", "properties": { "kind": { "deprecated": true, "type": "string" }, "email": { "description": "If return_oob_link is false in the request, the email address the verification was sent to.", "type": "string" }, "oobLink": { "description": "If return_oob_link is true in the request, the OOB link to be sent to the user. This returns the constructed link including [Firebase Dynamic Link](https://firebase.google.com/docs/dynamic-links) related parameters.", "type": "string" }, "oobCode": { "description": "If return_oob_link is true in the request, the OOB code to send.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse": { "properties": { "sessionInfo": { "description": "Encrypted session information. This can be used in signInWithPhoneNumber to authenticate the phone number.", "type": "string" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1SendVerificationCodeResponse", "description": "Response message for SendVerificationCode." }, "GoogleCloudIdentitytoolkitV1ResetPasswordRequest": { "type": "object", "properties": { "email": { "description": "Optional. The email of the account to be modified. Specify this and the old password in order to change an account's password without using an out-of-band code.", "type": "string" }, "tenantId": { "description": "Optional. The tenant ID of the Identity Platform tenant the account belongs to.", "type": "string" }, "newPassword": { "description": "The new password to be set for this account. Specifying this field will result in a change to the account and consume the out-of-band code if one was specified and it was of type PASSWORD_RESET.", "type": "string" }, "oldPassword": { "description": "The current password of the account to be modified. Specify this and email to change an account's password without using an out-of-band code.", "type": "string" }, "oobCode": { "description": "An out-of-band (OOB) code generated by GetOobCode request. Specify only this parameter (or only this parameter and a tenant ID) to get the out-of-band code's type in the response without mutating the account's state. Only a PASSWORD_RESET out-of-band code can be consumed via this method.", "type": "string" } }, "description": "Request message for ResetPassword.", "id": "GoogleCloudIdentitytoolkitV1ResetPasswordRequest" }, "GoogleCloudIdentitytoolkitV1OpenIdConnectKey": { "type": "object", "properties": { "n": { "description": "Modulus for the RSA public key, it is represented as the base64url encoding of the value's big endian representation.", "type": "string" }, "kty": { "description": "Key type.", "type": "string" }, "alg": { "description": "Signature algorithm.", "type": "string" }, "use": { "description": "Key use.", "type": "string" }, "kid": { "description": "Unique string to identify this key.", "type": "string" }, "e": { "description": "Exponent for the RSA public key, it is represented as the base64url encoding of the value's big endian representation.", "type": "string" } }, "description": "Represents a public key of the session cookie signer, formatted as a [JSON Web Key (JWK)](https://tools.ietf.org/html/rfc7517).", "id": "GoogleCloudIdentitytoolkitV1OpenIdConnectKey" }, "GoogleCloudIdentitytoolkitV1AutoRetrievalInfo": { "id": "GoogleCloudIdentitytoolkitV1AutoRetrievalInfo", "description": "The information required to auto-retrieve an SMS.", "properties": { "appSignatureHash": { "description": "The Android app's signature hash for Google Play Service's SMS Retriever API.", "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1GetOobCodeRequest": { "type": "object", "properties": { "idToken": { "description": "An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true.", "type": "string" }, "iOSBundleId": { "description": "If an associated iOS app can handle the OOB code, the iOS bundle id of this app. This will allow the correct app to open if it is already installed.", "type": "string" }, "returnOobLink": { "description": "Whether the confirmation link containing the OOB code should be returned in the response (no email is sent). Used when a developer wants to construct the email template and send it on their own. By default this is false; to specify this field, and to set it to true, it requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control)", "type": "boolean" }, "iOSAppStoreId": { "description": "If an associated iOS app can handle the OOB code, the App Store id of this app. This will allow App Store to open to the correct app if the app is not yet installed.", "type": "string" }, "requestType": { "enumDescriptions": [ "Oob code type is not specified.", "reset password", "", "", "verify the account's email address by sending an email", "", "sign in with email only", "This flow sends an email to the specified new email, and when applied by clicking the link in the email changes the account's email to the new email. Used when the account must have verified email at all times, such as MFA accounts.", "" ], "enum": [ "OOB_REQ_TYPE_UNSPECIFIED", "PASSWORD_RESET", "OLD_EMAIL_AGREE", "NEW_EMAIL_ACCEPT", "VERIFY_EMAIL", "RECOVER_EMAIL", "EMAIL_SIGNIN", "VERIFY_AND_CHANGE_EMAIL", "REVERT_SECOND_FACTOR_ADDITION" ], "description": "Required. The type of out-of-band (OOB) code to send. Depending on this value, other fields in this request will be required and/or have different meanings. There are 4 different OOB codes that can be sent: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL", "enumDeprecated": [ false, false, true, true, false, true, false, false, true ], "type": "string" }, "tenantId": { "description": "The tenant ID of the Identity Platform tenant the account belongs to.", "type": "string" }, "androidInstallApp": { "description": "If an associated android app can handle the OOB code, whether or not to install the android app on the device where the link is opened if the app is not already installed.", "type": "boolean" }, "androidMinimumVersion": { "description": "If an associated android app can handle the OOB code, the minimum version of the app. If the version on the device is lower than this version then the user is taken to Google Play Store to upgrade the app.", "type": "string" }, "recaptchaVersion": { "description": "The reCAPTCHA version of the reCAPTCHA token in the captcha_response.", "enum": [ "RECAPTCHA_VERSION_UNSPECIFIED", "RECAPTCHA_ENTERPRISE" ], "type": "string", "enumDescriptions": [ "The reCAPTCHA version is not specified.", "The reCAPTCHA enterprise." ] }, "canHandleCodeInApp": { "description": "When set to true, the OOB code link will be be sent as a Universal Link or an Android App Link and will be opened by the corresponding app if installed. If not set, or set to false, the OOB code will be sent to the web widget first and then on continue will redirect to the app if installed.", "type": "boolean" }, "targetProjectId": { "description": "The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).", "type": "string" }, "userIp": { "description": "The IP address of the caller. Required only for PASSWORD_RESET requests.", "type": "string" }, "email": { "description": "The account's email address to send the OOB code to, and generally the email address of the account that needs to be updated. Required for PASSWORD_RESET, EMAIL_SIGNIN, and VERIFY_EMAIL. Only required for VERIFY_AND_CHANGE_EMAIL requests when return_oob_link is set to true. In this case, it is the original email of the user.", "type": "string" }, "androidPackageName": { "description": "If an associated android app can handle the OOB code, the Android package name of the android app that will handle the callback when this OOB code is used. This will allow the correct app to open if it is already installed, or allow Google Play Store to open to the correct app if it is not yet installed.", "type": "string" }, "captchaResp": { "description": "For a PASSWORD_RESET request, a reCaptcha response is required when the system detects possible abuse activity. In those cases, this is the response from the reCaptcha challenge used to verify the caller.", "type": "string" }, "challenge": { "deprecated": true, "type": "string" }, "continueUrl": { "description": "The Url to continue after user clicks the link sent in email. This is the url that will allow the web widget to handle the OOB code.", "type": "string" }, "linkDomain": { "description": "Optional. In order to ensure that the url used can be easily opened in iOS or Android, we create a Hosting link '/__/auth/links'. This optional field contains the domain to use when constructing a Hosting link. If not set, '.firebaseapp.com' domain will be used.", "type": "string" }, "clientType": { "enumDescriptions": [ "Client type is not specified.", "Client type is web.", "Client type is android.", "Client type is ios." ], "type": "string", "enum": [ "CLIENT_TYPE_UNSPECIFIED", "CLIENT_TYPE_WEB", "CLIENT_TYPE_ANDROID", "CLIENT_TYPE_IOS" ], "description": "The client type: web, Android or iOS. Required when reCAPTCHA Enterprise protection is enabled." }, "newEmail": { "description": "The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests.", "type": "string" }, "dynamicLinkDomain": { "description": "In order to ensure that the url used can be easily opened up in iOS or android, we create a [Firebase Dynamic Link](https://firebase.google.com/docs/dynamic-links). Most Identity Platform projects will only have one Dynamic Link domain enabled, and can leave this field blank. This field contains a specified Dynamic Link domain for projects that have multiple enabled.", "type": "string" } }, "description": "Request message for GetOobCode.", "id": "GoogleCloudIdentitytoolkitV1GetOobCodeRequest" }, "GoogleCloudIdentitytoolkitV1MfaEnrollment": { "id": "GoogleCloudIdentitytoolkitV1MfaEnrollment", "description": "Information on which multi-factor authentication (MFA) providers are enabled for an account.", "properties": { "emailInfo": { "description": "Contains information specific to email MFA.", "$ref": "GoogleCloudIdentitytoolkitV1EmailInfo" }, "mfaEnrollmentId": { "description": "ID of this MFA option.", "type": "string" }, "phoneInfo": { "description": "Normally this will show the phone number associated with this enrollment. In some situations, such as after a first factor sign in, it will only show the obfuscated version of the associated phone number.", "type": "string" }, "totpInfo": { "description": "Contains information specific to TOTP MFA.", "$ref": "GoogleCloudIdentitytoolkitV1TotpInfo" }, "displayName": { "description": "Display name for this mfa option e.g. \"corp cell phone\".", "type": "string" }, "unobfuscatedPhoneInfo": { "type": "string", "readOnly": true, "description": "Output only. Unobfuscated phone_info." }, "enrolledAt": { "type": "string", "description": "Timestamp when the account enrolled this second factor.", "format": "google-datetime" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest": { "description": "Request message for SignInWithGameCenter", "id": "GoogleCloudIdentitytoolkitV1SignInWithGameCenterRequest", "type": "object", "properties": { "publicKeyUrl": { "description": "Required. The URL to fetch the Apple public key in order to verify the given signature is signed by Apple.", "type": "string" }, "teamPlayerId": { "description": "The user's Game Center team player ID. A unique identifier for a player of all the games that you distribute using your developer account. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid", "type": "string" }, "timestamp": { "description": "Required. The time when the signature was created by Apple, in milliseconds since the epoch.", "format": "int64", "type": "string" }, "salt": { "description": "Required. A random string used to generate the given signature.", "type": "string" }, "tenantId": { "description": "The ID of the Identity Platform tenant the user is signing in to.", "type": "string" }, "gamePlayerId": { "description": "The user's Game Center game player ID. A unique identifier for a player of the game. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid", "type": "string" }, "playerId": { "description": "Required. The user's Game Center player ID. Deprecated by Apple. Pass `playerID` along with `gamePlayerID` and `teamPlayerID` to initiate the migration of a user's Game Center player ID to `gamePlayerID`.", "type": "string" }, "idToken": { "description": "A valid ID token for an Identity Platform account. If present, this request will link the Game Center player ID to the account represented by this ID token.", "type": "string" }, "displayName": { "description": "The user's Game Center display name.", "type": "string" }, "signature": { "description": "Required. The verification signature data generated by Apple.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1SetAccountInfoResponse": { "id": "GoogleCloudIdentitytoolkitV1SetAccountInfoResponse", "description": "Response message for SetAccountInfo", "properties": { "photoUrl": { "description": "The user's photo URL for the account's profile photo.", "deprecated": true, "type": "string" }, "refreshToken": { "description": "A refresh token for the account. This is used for legacy user sign up.", "type": "string" }, "expiresIn": { "type": "string", "description": "The number of seconds until the Identity Platform ID token expires.", "format": "int64" }, "localId": { "description": "The ID of the authenticated user.", "type": "string" }, "displayName": { "description": "The account's display name.", "deprecated": true, "type": "string" }, "idToken": { "description": "An Identity Platform ID token for the account. This is used for legacy user sign up.", "type": "string" }, "kind": { "deprecated": true, "type": "string" }, "email": { "description": "The account's email address.", "deprecated": true, "type": "string" }, "emailVerified": { "description": "Whether the account's email has been verified.", "type": "boolean" }, "newEmail": { "description": "The new email that has been set on the user's account attributes.", "type": "string" }, "providerUserInfo": { "description": "The linked Identity Providers on the account.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1ProviderUserInfo" }, "type": "array" }, "passwordHash": { "description": "Deprecated. No actual password hash is currently returned.", "deprecated": true, "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1UserNotification": { "properties": { "notificationMessage": { "description": "Warning notification string. Can be used as fallback.", "type": "string" }, "notificationCode": { "enumDescriptions": [ "No notification specified.", "Password missing lowercase character.", "Password missing uppercase character.", "Password missing numeric character.", "Password missing non alphanumeric character.", "Password less than minimum required length.", "Password greater than maximum required length." ], "type": "string", "enum": [ "NOTIFICATION_CODE_UNSPECIFIED", "MISSING_LOWERCASE_CHARACTER", "MISSING_UPPERCASE_CHARACTER", "MISSING_NUMERIC_CHARACTER", "MISSING_NON_ALPHANUMERIC_CHARACTER", "MINIMUM_PASSWORD_LENGTH", "MAXIMUM_PASSWORD_LENGTH" ], "description": "Warning notification enum. Can be used for localization." } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1UserNotification", "description": "Warning notifications for the user." }, "GoogleCloudIdentitytoolkitV1MfaFactor": { "id": "GoogleCloudIdentitytoolkitV1MfaFactor", "type": "object", "properties": { "displayName": { "description": "Display name for this mfa option e.g. \"corp cell phone\".", "type": "string" }, "phoneInfo": { "description": "Phone number to receive OTP for MFA.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1BatchDeleteErrorInfo": { "properties": { "localId": { "description": "The corresponding user ID.", "type": "string" }, "index": { "type": "integer", "description": "The index of the errored item in the original local_ids field.", "format": "int32" }, "message": { "description": "Detailed error message.", "type": "string" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1BatchDeleteErrorInfo", "description": "Error info for account failed to be deleted." }, "GoogleCloudIdentitytoolkitV1DeleteAccountRequest": { "description": "Request message for DeleteAccount.", "id": "GoogleCloudIdentitytoolkitV1DeleteAccountRequest", "type": "object", "properties": { "tenantId": { "description": "The ID of the tenant that the account belongs to, if applicable. Only require to be specified for authenticated requests bearing a Google OAuth 2.0 credential that specify local_id of an account that belongs to an Identity Platform tenant.", "type": "string" }, "delegatedProjectNumber": { "format": "int64", "deprecated": true, "type": "string" }, "localId": { "description": "The ID of user account to delete. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control). Requests from users lacking the credential should pass an ID token instead.", "type": "string" }, "idToken": { "description": "The Identity Platform ID token of the account to delete. Require to be specified for requests from end users that lack Google OAuth 2.0 credential. Authenticated requests bearing a Google OAuth2 credential with proper permissions may pass local_id to specify the account to delete alternatively.", "type": "string" }, "targetProjectId": { "description": "The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify local_id of an account.", "type": "string" } } }, "GoogleCloudIdentitytoolkitV1CreateAuthUriRequest": { "properties": { "context": { "description": "An opaque string used to maintain contextual information between the authentication request and the callback from the IdP.", "type": "string" }, "sessionId": { "description": "A session ID that can be verified against in SignInWithIdp to prevent session fixation attacks. If absent, a random string will be generated and returned as the session ID.", "type": "string" }, "customParameter": { "type": "object", "description": "Additional customized query parameters to be added to the authorization URI. The following parameters are reserved and cannot be added: `client_id`, `response_type`, `scope`, `redirect_uri`, `state`. For the Microsoft provider, the Azure AD tenant to sign-in to can be specified in the `tenant` custom parameter.", "additionalProperties": { "type": "string" } }, "identifier": { "description": "The email identifier of the user account to fetch associated providers for. At least one of the fields `identifier` and `provider_id` must be set. The length of the email address should be less than 256 characters and in the format of `name@domain.tld`. The email address should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production.", "type": "string" }, "oauthScope": { "description": "Additional space-delimited OAuth 2.0 scopes specifying the scope of the authentication request with the IdP. Used for OAuth 2.0 IdPs. For the Google provider, the authorization code flow will be used if this field is set.", "type": "string" }, "oauthConsumerKey": { "deprecated": true, "type": "string" }, "otaApp": { "deprecated": true, "type": "string" }, "appId": { "deprecated": true, "type": "string" }, "hostedDomain": { "description": "Used for the Google provider. The G Suite hosted domain of the user in order to restrict sign-in to users at that domain.", "type": "string" }, "tenantId": { "description": "The ID of the Identity Platform tenant to create an authorization URI or lookup an email identifier for. If not set, the operation will be performed in the default Identity Platform instance in the project.", "type": "string" }, "providerId": { "description": "The provider ID of the IdP for the user to sign in with. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`. At least one of the fields `identifier` and `provider_id` must be set.", "type": "string" }, "authFlowType": { "description": "Used for the Google provider. The type of the authentication flow to be used. If present, this should be `CODE_FLOW` to specify the authorization code flow. Otherwise, the default ID Token flow will be used.", "type": "string" }, "continueUri": { "description": "A valid URL for the IdP to redirect the user back to. The URL cannot contain fragments or the reserved `state` query parameter.", "type": "string" }, "openidRealm": { "deprecated": true, "type": "string" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1CreateAuthUriRequest", "description": "Request message for CreateAuthUri." }, "GoogleCloudIdentitytoolkitV1GetAccountInfoResponse": { "id": "GoogleCloudIdentitytoolkitV1GetAccountInfoResponse", "description": "Response message for GetAccountInfo.", "properties": { "kind": { "deprecated": true, "type": "string" }, "users": { "type": "array", "description": "The information of specific user account(s) matching the parameters in the request.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1UserInfo" } } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse": { "id": "GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse", "description": "Response message for SignInWithPhoneNumber.", "properties": { "temporaryProof": { "description": "A proof of the phone number verification, provided if a phone authentication is successful but the user operation fails. This happens when the request tries to link a phone number to a user with an ID token or reauthenticate with an ID token but the phone number is linked to a different user.", "type": "string" }, "phoneNumber": { "description": "Phone number of the authenticated user. Always present in the response.", "type": "string" }, "idToken": { "description": "Identity Platform ID token for the authenticated user.", "type": "string" }, "isNewUser": { "description": "Whether the authenticated user was created by this request.", "type": "boolean" }, "verificationProofExpiresIn": { "description": "Do not use.", "format": "int64", "type": "string" }, "refreshToken": { "description": "Refresh token for the authenticated user.", "type": "string" }, "expiresIn": { "description": "The number of seconds until the ID token expires.", "format": "int64", "type": "string" }, "localId": { "description": "The id of the authenticated user. Present in the case of a successful authentication. In the case when the phone could be verified but the account operation could not be performed, a temporary proof will be returned instead.", "type": "string" }, "verificationProof": { "description": "Do not use.", "type": "string" }, "temporaryProofExpiresIn": { "type": "string", "description": "The number of seconds until the temporary proof expires.", "format": "int64" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1EmailInfo": { "id": "GoogleCloudIdentitytoolkitV1EmailInfo", "description": "Information about email MFA.", "properties": { "emailAddress": { "description": "Email address that a MFA verification should be sent to.", "type": "string" } }, "type": "object" }, "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest": { "type": "object", "properties": { "phoneNumber": { "description": "The phone number to send the verification code to in E.164 format.", "type": "string" }, "playIntegrityToken": { "description": "Android only. Used to assert application identity in place of a recaptcha token (and safety_net_token). At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, , or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). A Play Integrity Token can be generated via the [PlayIntegrity API](https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce.", "type": "string" }, "autoRetrievalInfo": { "description": "Android only. Used by Google Play Services to identify the app for auto-retrieval.", "$ref": "GoogleCloudIdentitytoolkitV1AutoRetrievalInfo" }, "captchaResponse": { "description": "Optional. The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.", "type": "string" }, "recaptchaVersion": { "enum": [ "RECAPTCHA_VERSION_UNSPECIFIED", "RECAPTCHA_ENTERPRISE" ], "description": "Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.", "enumDescriptions": [ "The reCAPTCHA version is not specified.", "The reCAPTCHA enterprise." ], "type": "string" }, "tenantId": { "description": "Tenant ID of the Identity Platform tenant the user is signing in to.", "type": "string" }, "iosSecret": { "description": "Secret delivered to iOS app as a push notification. Should be passed with an `ios_receipt` as well as the `x-ios-bundle-identifier` header.", "type": "string" }, "recaptchaToken": { "description": "Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge.", "type": "string" }, "clientType": { "description": "Optional. The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.", "enum": [ "CLIENT_TYPE_UNSPECIFIED", "CLIENT_TYPE_WEB", "CLIENT_TYPE_ANDROID", "CLIENT_TYPE_IOS" ], "type": "string", "enumDescriptions": [ "Client type is not specified.", "Client type is web.", "Client type is android.", "Client type is ios." ] }, "safetyNetToken": { "description": "Android only. Safety Net has been deprecated. Use play_integrity_token instead.", "type": "string" }, "iosReceipt": { "description": "Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request.", "type": "string" } }, "description": "Request message for SendVerificationCode. 'captcha_response' is required when reCAPTCHA enterprise is enabled, or otherwise at least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator.", "id": "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest" }, "GoogleCloudIdentitytoolkitV1SignInWithIdpRequest": { "properties": { "requestUri": { "description": "Required. The URL to which the IdP redirects the user back. This can be set to `http://localhost` if the user is signing in with a manually provided IdP credential.", "type": "string" }, "postBody": { "description": "If the user is signing in with an authorization response obtained via a previous CreateAuthUri authorization request, this is the body of the HTTP POST callback from the IdP, if present. Otherwise, if the user is signing in with a manually provided IdP credential, this should be a URL-encoded form that contains the credential (e.g. an ID token or access token for OAuth 2.0 IdPs) and the provider ID of the IdP that issued the credential. For example, if the user is signing in to the Google provider using a Google ID token, this should be set to id_token`=[GOOGLE_ID_TOKEN]&providerId=google.com`, where `[GOOGLE_ID_TOKEN]` should be replaced with the Google ID token. If the user is signing in to the Facebook provider using a Facebook authentication token, this should be set to id_token`=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId=facebook. com&nonce= [NONCE]`, where `[FACEBOOK_AUTHENTICATION_TOKEN]` should be replaced with the Facebook authentication token. Nonce is required for validating the token. The request will fail if no nonce is provided. If the user is signing in to the Facebook provider using a Facebook access token, this should be set to access_token`=[FACEBOOK_ACCESS_TOKEN]&providerId=facebook. com`, where `[FACEBOOK_ACCESS_TOKEN]` should be replaced with the Facebook access token. If the user is signing in to the Twitter provider using a Twitter OAuth 1.0 credential, this should be set to access_token`=[TWITTER_ACCESS_TOKEN]&oauth_token_secret= [TWITTER_TOKEN_SECRET]&providerId=twitter.com`, where `[TWITTER_ACCESS_TOKEN]` and `[TWITTER_TOKEN_SECRET]` should be replaced with the Twitter OAuth access token and Twitter OAuth token secret respectively.", "type": "string" }, "returnSecureToken": { "description": "Should always be true.", "type": "boolean" }, "tenantId": { "description": "The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.", "type": "string" }, "sessionId": { "description": "The session ID returned from a previous CreateAuthUri call. This field is verified against that session ID to prevent session fixation attacks. Required if the user is signing in with an authorization response from a previous CreateAuthUri authorization request.", "type": "string" }, "pendingToken": { "description": "An opaque string from a previous SignInWithIdp response. If set, it can be used to repeat the sign-in operation from the previous SignInWithIdp operation. This may be present if the user needs to confirm their account information as part of a previous federated login attempt, or perform account linking.", "type": "string" }, "pendingIdToken": { "deprecated": true, "type": "string" }, "autoCreate": { "deprecated": true, "type": "boolean" }, "idToken": { "description": "A valid Identity Platform ID token. If passed, the user's account at the IdP will be linked to the account represented by this ID token.", "type": "string" }, "returnIdpCredential": { "description": "Whether or not to return OAuth credentials from the IdP on the following errors: `FEDERATED_USER_ID_ALREADY_LINKED` and `EMAIL_EXISTS`.", "type": "boolean" }, "returnRefreshToken": { "description": "Whether or not to return the OAuth refresh token from the IdP, if available.", "type": "boolean" }, "delegatedProjectNumber": { "deprecated": true, "type": "string", "format": "int64" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1SignInWithIdpRequest", "description": "Request message for SignInWithIdp." }, "GoogleCloudIdentitytoolkitV1UploadAccountRequest": { "properties": { "saltSeparator": { "description": "One or more bytes to be inserted between the salt and plain text password. For stronger security, this should be a single non-printable character.", "format": "byte", "type": "string" }, "tenantId": { "description": "The ID of the Identity Platform tenant the account belongs to.", "type": "string" }, "passwordHashOrder": { "enum": [ "UNSPECIFIED_ORDER", "SALT_AND_PASSWORD", "PASSWORD_AND_SALT" ], "type": "string", "enumDescriptions": [ "The order is not specified.", "The order is salt first, and then password.", "The order is password first, and then salt." ] }, "sanityCheck": { "description": "If true, the service will do the following list of checks before an account is uploaded: * Duplicate emails * Duplicate federated IDs * Federated ID provider validation If the duplication exists within the list of accounts to be uploaded, it will prevent the entire list from being uploaded. If the email or federated ID is a duplicate of a user already within the project/tenant, the account will not be uploaded, but the rest of the accounts will be unaffected. If false, these checks will be skipped.", "type": "boolean" }, "users": { "type": "array", "description": "A list of accounts to upload. `local_id` is required for each user; everything else is optional.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1UserInfo" } }, "rounds": { "description": "The number of rounds used for hash calculation. Only required for the following hashing functions: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT", "format": "int32", "type": "integer" }, "argon2Parameters": { "description": "The parameters for Argon2 hashing algorithm.", "$ref": "GoogleCloudIdentitytoolkitV1Argon2Parameters" }, "signerKey": { "description": "The signer key used to hash the password. Required for the following hashing functions: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512", "format": "byte", "type": "string" }, "dkLen": { "type": "integer", "description": "The desired key length for the STANDARD_SCRYPT hashing function. Must be at least 1.", "format": "int32" }, "cpuMemCost": { "type": "integer", "description": "The CPU memory cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance.", "format": "int32" }, "parallelization": { "type": "integer", "description": "The parallelization cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance.", "format": "int32" }, "blockSize": { "description": "The block size parameter used by the STANDARD_SCRYPT hashing function. This parameter, along with parallelization and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance.", "format": "int32", "type": "integer" }, "delegatedProjectNumber": { "format": "int64", "deprecated": true, "type": "string" }, "allowOverwrite": { "description": "Whether to overwrite an existing account in Identity Platform with a matching `local_id` in the request. If true, the existing account will be overwritten. If false, an error will be returned.", "type": "boolean" }, "memoryCost": { "description": "Memory cost for hash calculation. Only required when the hashing function is SCRYPT.", "format": "int32", "type": "integer" }, "hashAlgorithm": { "description": "Required. The hashing function used to hash the account passwords. Must be one of the following: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2", "type": "string" } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1UploadAccountRequest", "description": "Request message for UploadAccount." }, "GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse": { "type": "object", "properties": { "errors": { "description": "Detailed error info for accounts that cannot be deleted.", "items": { "$ref": "GoogleCloudIdentitytoolkitV1BatchDeleteErrorInfo" }, "type": "array" } }, "description": "Response message to BatchDeleteAccounts.", "id": "GoogleCloudIdentitytoolkitV1BatchDeleteAccountsResponse" }, "GoogleCloudIdentitytoolkitV1QueryUserInfoRequest": { "properties": { "tenantId": { "description": "The ID of the tenant to which the result is scoped.", "type": "string" }, "offset": { "description": "The number of accounts to skip from the beginning of matching records. Only valid when `return_user_info` is set to `true`.", "format": "int64", "type": "string" }, "returnUserInfo": { "description": "If `true`, this request will return the accounts matching the query. If `false`, only the __count__ of accounts matching the query will be returned. Defaults to `true`.", "type": "boolean" }, "limit": { "type": "string", "description": "The maximum number of accounts to return with an upper limit of __500__. Defaults to _500_. Only valid when `return_user_info` is set to `true`.", "format": "int64" }, "sortBy": { "type": "string", "enumDescriptions": [ "Sort field is not specified.", "Sort result by userId.", "Sort result by name.", "Sort result by createdAt.", "Sort result by lastLoginAt.", "Sort result by userEmail." ], "enum": [ "SORT_BY_FIELD_UNSPECIFIED", "USER_ID", "NAME", "CREATED_AT", "LAST_LOGIN_AT", "USER_EMAIL" ] }, "order": { "type": "string", "enumDescriptions": [ "Order is not specified.", "Sort on ascending order.", "Sort on descending order." ], "enum": [ "ORDER_UNSPECIFIED", "ASC", "DESC" ] }, "expression": { "type": "array", "items": { "$ref": "GoogleCloudIdentitytoolkitV1SqlExpression" } } }, "type": "object", "id": "GoogleCloudIdentitytoolkitV1QueryUserInfoRequest", "description": "Request message for QueryUserInfo." }, "GoogleCloudIdentitytoolkitV1TotpInfo": { "type": "object", "properties": {}, "description": "Information about TOTP MFA.", "id": "GoogleCloudIdentitytoolkitV1TotpInfo" } }, "servicePath": "", "discoveryVersion": "v1", "title": "Identity Toolkit API", "fullyEncodeReservedExpansion": true, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." }, "https://www.googleapis.com/auth/firebase": { "description": "View and administer all your Firebase data and settings" } } } }, "version": "v1", "canonicalName": "Identity Toolkit", "rootUrl": "https://identitytoolkit.googleapis.com/", "revision": "20260330", "mtlsRootUrl": "https://identitytoolkit.mtls.googleapis.com/", "batchPath": "batch", "ownerName": "Google", "version_module": true, "basePath": "", "documentationLink": "https://cloud.google.com/identity-platform", "description": "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", "parameters": { "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "enum": [ "json", "media", "proto" ], "location": "query", "description": "Data format for response.", "default": "json", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "access_token": { "type": "string", "location": "query", "description": "OAuth access token." }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "$.xgafv": { "type": "string", "enum": [ "1", "2" ], "location": "query", "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query", "type": "boolean" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "quotaUser": { "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" } } }