relyingparty

Creates, updates, deletes, gets or lists a relyingparty resource.

Overview

Name	relyingparty
Type	Resource
Id	google.identitytoolkit.relyingparty

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
download_account	exec			Batch download user accounts.
email_link_signin	exec			Reset password for a user.
reset_password	exec			Reset password for a user.
send_verification_code	exec			Send SMS verification code.
set_account_info	exec			Set account info for a user.
set_project_config	exec			Set project configuration.
sign_out_user	exec			Sign out user.
signup_new_user	exec			Signup new user.
upload_account	exec			Batch upload existing user accounts.
verify_assertion	exec			Verifies the assertion returned by the IdP.
verify_custom_token	exec			Verifies the developer asserted ID token.
verify_password	exec			Verifies the user entered password.
verify_phone_number	exec			Verifies ownership of a phone number and creates/updates the user account accordingly.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description

Lifecycle Methods

download_account

Batch download user accounts.

EXEC google.identitytoolkit.relyingparty.download_account 
@@json=
'{
"delegatedProjectNumber": "{{ delegatedProjectNumber }}", 
"maxResults": {{ maxResults }}, 
"nextPageToken": "{{ nextPageToken }}", 
"targetProjectId": "{{ targetProjectId }}"
}';

email_link_signin

Reset password for a user.

EXEC google.identitytoolkit.relyingparty.email_link_signin 
@@json=
'{
"email": "{{ email }}", 
"idToken": "{{ idToken }}", 
"oobCode": "{{ oobCode }}"
}';

reset_password

Reset password for a user.

EXEC google.identitytoolkit.relyingparty.reset_password 
@@json=
'{
"email": "{{ email }}", 
"newPassword": "{{ newPassword }}", 
"oldPassword": "{{ oldPassword }}", 
"oobCode": "{{ oobCode }}"
}';

send_verification_code

Send SMS verification code.

EXEC google.identitytoolkit.relyingparty.send_verification_code 
@@json=
'{
"iosReceipt": "{{ iosReceipt }}", 
"iosSecret": "{{ iosSecret }}", 
"phoneNumber": "{{ phoneNumber }}", 
"recaptchaToken": "{{ recaptchaToken }}"
}';

set_account_info

Set account info for a user.

EXEC google.identitytoolkit.relyingparty.set_account_info 
@@json=
'{
"captchaChallenge": "{{ captchaChallenge }}", 
"captchaResponse": "{{ captchaResponse }}", 
"createdAt": "{{ createdAt }}", 
"customAttributes": "{{ customAttributes }}", 
"delegatedProjectNumber": "{{ delegatedProjectNumber }}", 
"deleteAttribute": "{{ deleteAttribute }}", 
"deleteProvider": "{{ deleteProvider }}", 
"disableUser": {{ disableUser }}, 
"displayName": "{{ displayName }}", 
"email": "{{ email }}", 
"emailVerified": {{ emailVerified }}, 
"idToken": "{{ idToken }}", 
"instanceId": "{{ instanceId }}", 
"lastLoginAt": "{{ lastLoginAt }}", 
"localId": "{{ localId }}", 
"oobCode": "{{ oobCode }}", 
"password": "{{ password }}", 
"phoneNumber": "{{ phoneNumber }}", 
"photoUrl": "{{ photoUrl }}", 
"provider": "{{ provider }}", 
"returnSecureToken": {{ returnSecureToken }}, 
"upgradeToFederatedLogin": {{ upgradeToFederatedLogin }}, 
"validSince": "{{ validSince }}"
}';

set_project_config

Set project configuration.

EXEC google.identitytoolkit.relyingparty.set_project_config 
@@json=
'{
"allowPasswordUser": {{ allowPasswordUser }}, 
"apiKey": "{{ apiKey }}", 
"authorizedDomains": "{{ authorizedDomains }}", 
"changeEmailTemplate": "{{ changeEmailTemplate }}", 
"delegatedProjectNumber": "{{ delegatedProjectNumber }}", 
"enableAnonymousUser": {{ enableAnonymousUser }}, 
"idpConfig": "{{ idpConfig }}", 
"legacyResetPasswordTemplate": "{{ legacyResetPasswordTemplate }}", 
"resetPasswordTemplate": "{{ resetPasswordTemplate }}", 
"useEmailSending": {{ useEmailSending }}, 
"verifyEmailTemplate": "{{ verifyEmailTemplate }}"
}';

sign_out_user

Sign out user.

EXEC google.identitytoolkit.relyingparty.sign_out_user 
@@json=
'{
"instanceId": "{{ instanceId }}", 
"localId": "{{ localId }}"
}';

signup_new_user

Signup new user.

EXEC google.identitytoolkit.relyingparty.signup_new_user 
@@json=
'{
"captchaChallenge": "{{ captchaChallenge }}", 
"captchaResponse": "{{ captchaResponse }}", 
"disabled": {{ disabled }}, 
"displayName": "{{ displayName }}", 
"email": "{{ email }}", 
"emailVerified": {{ emailVerified }}, 
"idToken": "{{ idToken }}", 
"instanceId": "{{ instanceId }}", 
"localId": "{{ localId }}", 
"password": "{{ password }}", 
"phoneNumber": "{{ phoneNumber }}", 
"photoUrl": "{{ photoUrl }}", 
"tenantId": "{{ tenantId }}", 
"tenantProjectNumber": "{{ tenantProjectNumber }}"
}';

upload_account

Batch upload existing user accounts.

EXEC google.identitytoolkit.relyingparty.upload_account 
@@json=
'{
"allowOverwrite": {{ allowOverwrite }}, 
"blockSize": {{ blockSize }}, 
"cpuMemCost": {{ cpuMemCost }}, 
"delegatedProjectNumber": "{{ delegatedProjectNumber }}", 
"dkLen": {{ dkLen }}, 
"hashAlgorithm": "{{ hashAlgorithm }}", 
"memoryCost": {{ memoryCost }}, 
"parallelization": {{ parallelization }}, 
"rounds": {{ rounds }}, 
"saltSeparator": "{{ saltSeparator }}", 
"sanityCheck": {{ sanityCheck }}, 
"signerKey": "{{ signerKey }}", 
"targetProjectId": "{{ targetProjectId }}", 
"users": "{{ users }}"
}';

verify_assertion

Verifies the assertion returned by the IdP.

EXEC google.identitytoolkit.relyingparty.verify_assertion 
@@json=
'{
"autoCreate": {{ autoCreate }}, 
"delegatedProjectNumber": "{{ delegatedProjectNumber }}", 
"idToken": "{{ idToken }}", 
"instanceId": "{{ instanceId }}", 
"pendingIdToken": "{{ pendingIdToken }}", 
"postBody": "{{ postBody }}", 
"requestUri": "{{ requestUri }}", 
"returnIdpCredential": {{ returnIdpCredential }}, 
"returnRefreshToken": {{ returnRefreshToken }}, 
"returnSecureToken": {{ returnSecureToken }}, 
"sessionId": "{{ sessionId }}", 
"tenantId": "{{ tenantId }}", 
"tenantProjectNumber": "{{ tenantProjectNumber }}"
}';

verify_custom_token

Verifies the developer asserted ID token.

EXEC google.identitytoolkit.relyingparty.verify_custom_token 
@@json=
'{
"delegatedProjectNumber": "{{ delegatedProjectNumber }}", 
"instanceId": "{{ instanceId }}", 
"returnSecureToken": {{ returnSecureToken }}, 
"token": "{{ token }}"
}';

verify_password

Verifies the user entered password.

EXEC google.identitytoolkit.relyingparty.verify_password 
@@json=
'{
"captchaChallenge": "{{ captchaChallenge }}", 
"captchaResponse": "{{ captchaResponse }}", 
"delegatedProjectNumber": "{{ delegatedProjectNumber }}", 
"email": "{{ email }}", 
"idToken": "{{ idToken }}", 
"instanceId": "{{ instanceId }}", 
"password": "{{ password }}", 
"pendingIdToken": "{{ pendingIdToken }}", 
"returnSecureToken": {{ returnSecureToken }}, 
"tenantId": "{{ tenantId }}", 
"tenantProjectNumber": "{{ tenantProjectNumber }}"
}';

verify_phone_number

Verifies ownership of a phone number and creates/updates the user account accordingly.

EXEC google.identitytoolkit.relyingparty.verify_phone_number 
@@json=
'{
"code": "{{ code }}", 
"idToken": "{{ idToken }}", 
"operation": "{{ operation }}", 
"phoneNumber": "{{ phoneNumber }}", 
"sessionInfo": "{{ sessionInfo }}", 
"temporaryProof": "{{ temporaryProof }}", 
"verificationProof": "{{ verificationProof }}"
}';