class Relyingparty extends Resource (View source)

The "relyingparty" collection of methods.

Typical usage is:

 $identitytoolkitService = new Google\Service\IdentityToolkit(...);
 $relyingparty = $identitytoolkitService->relyingparty;

Methods

createAuthUri(IdentitytoolkitRelyingpartyCreateAuthUriRequest $postBody, array $optParams = [])

Creates the URI used by the IdP to authenticate the user.

deleteAccount(IdentitytoolkitRelyingpartyDeleteAccountRequest $postBody, array $optParams = [])

Delete user account. (relyingparty.deleteAccount)

downloadAccount(IdentitytoolkitRelyingpartyDownloadAccountRequest $postBody, array $optParams = [])

Batch download user accounts. (relyingparty.downloadAccount)

emailLinkSignin(IdentitytoolkitRelyingpartyEmailLinkSigninRequest $postBody, array $optParams = [])

Reset password for a user. (relyingparty.emailLinkSignin)

getAccountInfo(IdentitytoolkitRelyingpartyGetAccountInfoRequest $postBody, array $optParams = [])

Returns the account info. (relyingparty.getAccountInfo)

getOobConfirmationCode(Relyingparty $postBody, array $optParams = [])

Get a code for user action confirmation.

getProjectConfig(array $optParams = [])

Get project configuration. (relyingparty.getProjectConfig)

IdentitytoolkitRelyingpartyGetPublicKeysResponse
getPublicKeys(array $optParams = [])

Get token signing public key. (relyingparty.getPublicKeys)

getRecaptchaParam(array $optParams = [])

Get recaptcha secure param. (relyingparty.getRecaptchaParam)

resetPassword(IdentitytoolkitRelyingpartyResetPasswordRequest $postBody, array $optParams = [])

Reset password for a user. (relyingparty.resetPassword)

sendVerificationCode(IdentitytoolkitRelyingpartySendVerificationCodeRequest $postBody, array $optParams = [])

Send SMS verification code. (relyingparty.sendVerificationCode)

setAccountInfo(IdentitytoolkitRelyingpartySetAccountInfoRequest $postBody, array $optParams = [])

Set account info for a user. (relyingparty.setAccountInfo)

setProjectConfig(IdentitytoolkitRelyingpartySetProjectConfigRequest $postBody, array $optParams = [])

Set project configuration. (relyingparty.setProjectConfig)

signOutUser(IdentitytoolkitRelyingpartySignOutUserRequest $postBody, array $optParams = [])

Sign out user. (relyingparty.signOutUser)

signupNewUser(IdentitytoolkitRelyingpartySignupNewUserRequest $postBody, array $optParams = [])

Signup new user. (relyingparty.signupNewUser)

uploadAccount(IdentitytoolkitRelyingpartyUploadAccountRequest $postBody, array $optParams = [])

Batch upload existing user accounts. (relyingparty.uploadAccount)

verifyAssertion(IdentitytoolkitRelyingpartyVerifyAssertionRequest $postBody, array $optParams = [])

Verifies the assertion returned by the IdP. (relyingparty.verifyAssertion)

verifyCustomToken(IdentitytoolkitRelyingpartyVerifyCustomTokenRequest $postBody, array $optParams = [])

Verifies the developer asserted ID token. (relyingparty.verifyCustomToken)

verifyPassword(IdentitytoolkitRelyingpartyVerifyPasswordRequest $postBody, array $optParams = [])

Verifies the user entered password. (relyingparty.verifyPassword)

verifyPhoneNumber(IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest $postBody, array $optParams = [])

Verifies ownership of a phone number and creates/updates the user account accordingly. (relyingparty.verifyPhoneNumber)

Details

CreateAuthUriResponse createAuthUri(IdentitytoolkitRelyingpartyCreateAuthUriRequest $postBody, array $optParams = [])

Creates the URI used by the IdP to authenticate the user.

(relyingparty.createAuthUri)

Parameters

IdentitytoolkitRelyingpartyCreateAuthUriRequest $postBody
array $optParams

Optional parameters.

Return Value

CreateAuthUriResponse

Exceptions

Exception

DeleteAccountResponse deleteAccount(IdentitytoolkitRelyingpartyDeleteAccountRequest $postBody, array $optParams = [])

Delete user account. (relyingparty.deleteAccount)

Parameters

IdentitytoolkitRelyingpartyDeleteAccountRequest $postBody
array $optParams

Optional parameters.

Return Value

DeleteAccountResponse

Exceptions

Exception

DownloadAccountResponse downloadAccount(IdentitytoolkitRelyingpartyDownloadAccountRequest $postBody, array $optParams = [])

Batch download user accounts. (relyingparty.downloadAccount)

Parameters

IdentitytoolkitRelyingpartyDownloadAccountRequest $postBody
array $optParams

Optional parameters.

Return Value

DownloadAccountResponse

Exceptions

Exception

EmailLinkSigninResponse emailLinkSignin(IdentitytoolkitRelyingpartyEmailLinkSigninRequest $postBody, array $optParams = [])

Reset password for a user. (relyingparty.emailLinkSignin)

Parameters

IdentitytoolkitRelyingpartyEmailLinkSigninRequest $postBody
array $optParams

Optional parameters.

Return Value

EmailLinkSigninResponse

Exceptions

Exception

GetAccountInfoResponse getAccountInfo(IdentitytoolkitRelyingpartyGetAccountInfoRequest $postBody, array $optParams = [])

Returns the account info. (relyingparty.getAccountInfo)

Parameters

IdentitytoolkitRelyingpartyGetAccountInfoRequest $postBody
array $optParams

Optional parameters.

Return Value

GetAccountInfoResponse

Exceptions

Exception

GetOobConfirmationCodeResponse getOobConfirmationCode(Relyingparty $postBody, array $optParams = [])

Get a code for user action confirmation.

(relyingparty.getOobConfirmationCode)

Parameters

Relyingparty $postBody
array $optParams

Optional parameters.

Return Value

GetOobConfirmationCodeResponse

Exceptions

Exception

IdentitytoolkitRelyingpartyGetProjectConfigResponse getProjectConfig(array $optParams = [])

Get project configuration. (relyingparty.getProjectConfig)

Parameters

array $optParams

Optional parameters.

Return Value

IdentitytoolkitRelyingpartyGetProjectConfigResponse

Exceptions

Exception

IdentitytoolkitRelyingpartyGetPublicKeysResponse getPublicKeys(array $optParams = [])

Get token signing public key. (relyingparty.getPublicKeys)

Parameters

array $optParams

Optional parameters.

Return Value

IdentitytoolkitRelyingpartyGetPublicKeysResponse

Exceptions

Exception

GetRecaptchaParamResponse getRecaptchaParam(array $optParams = [])

Get recaptcha secure param. (relyingparty.getRecaptchaParam)

Parameters

array $optParams

Optional parameters.

Return Value

GetRecaptchaParamResponse

Exceptions

Exception

ResetPasswordResponse resetPassword(IdentitytoolkitRelyingpartyResetPasswordRequest $postBody, array $optParams = [])

Reset password for a user. (relyingparty.resetPassword)

Parameters

IdentitytoolkitRelyingpartyResetPasswordRequest $postBody
array $optParams

Optional parameters.

Return Value

ResetPasswordResponse

Exceptions

Exception

IdentitytoolkitRelyingpartySendVerificationCodeResponse sendVerificationCode(IdentitytoolkitRelyingpartySendVerificationCodeRequest $postBody, array $optParams = [])

Send SMS verification code. (relyingparty.sendVerificationCode)

Parameters

IdentitytoolkitRelyingpartySendVerificationCodeRequest $postBody
array $optParams

Optional parameters.

Return Value

IdentitytoolkitRelyingpartySendVerificationCodeResponse

Exceptions

Exception

SetAccountInfoResponse setAccountInfo(IdentitytoolkitRelyingpartySetAccountInfoRequest $postBody, array $optParams = [])

Set account info for a user. (relyingparty.setAccountInfo)

Parameters

IdentitytoolkitRelyingpartySetAccountInfoRequest $postBody
array $optParams

Optional parameters.

Return Value

SetAccountInfoResponse

Exceptions

Exception

IdentitytoolkitRelyingpartySetProjectConfigResponse setProjectConfig(IdentitytoolkitRelyingpartySetProjectConfigRequest $postBody, array $optParams = [])

Set project configuration. (relyingparty.setProjectConfig)

Parameters

IdentitytoolkitRelyingpartySetProjectConfigRequest $postBody
array $optParams

Optional parameters.

Return Value

IdentitytoolkitRelyingpartySetProjectConfigResponse

Exceptions

Exception

IdentitytoolkitRelyingpartySignOutUserResponse signOutUser(IdentitytoolkitRelyingpartySignOutUserRequest $postBody, array $optParams = [])

Sign out user. (relyingparty.signOutUser)

Parameters

IdentitytoolkitRelyingpartySignOutUserRequest $postBody
array $optParams

Optional parameters.

Return Value

IdentitytoolkitRelyingpartySignOutUserResponse

Exceptions

Exception

SignupNewUserResponse signupNewUser(IdentitytoolkitRelyingpartySignupNewUserRequest $postBody, array $optParams = [])

Signup new user. (relyingparty.signupNewUser)

Parameters

IdentitytoolkitRelyingpartySignupNewUserRequest $postBody
array $optParams

Optional parameters.

Return Value

SignupNewUserResponse

Exceptions

Exception

UploadAccountResponse uploadAccount(IdentitytoolkitRelyingpartyUploadAccountRequest $postBody, array $optParams = [])

Batch upload existing user accounts. (relyingparty.uploadAccount)

Parameters

IdentitytoolkitRelyingpartyUploadAccountRequest $postBody
array $optParams

Optional parameters.

Return Value

UploadAccountResponse

Exceptions

Exception

VerifyAssertionResponse verifyAssertion(IdentitytoolkitRelyingpartyVerifyAssertionRequest $postBody, array $optParams = [])

Verifies the assertion returned by the IdP. (relyingparty.verifyAssertion)

Parameters

IdentitytoolkitRelyingpartyVerifyAssertionRequest $postBody
array $optParams

Optional parameters.

Return Value

VerifyAssertionResponse

Exceptions

Exception

VerifyCustomTokenResponse verifyCustomToken(IdentitytoolkitRelyingpartyVerifyCustomTokenRequest $postBody, array $optParams = [])

Verifies the developer asserted ID token. (relyingparty.verifyCustomToken)

Parameters

IdentitytoolkitRelyingpartyVerifyCustomTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

VerifyCustomTokenResponse

Exceptions

Exception

VerifyPasswordResponse verifyPassword(IdentitytoolkitRelyingpartyVerifyPasswordRequest $postBody, array $optParams = [])

Verifies the user entered password. (relyingparty.verifyPassword)

Parameters

IdentitytoolkitRelyingpartyVerifyPasswordRequest $postBody
array $optParams

Optional parameters.

Return Value

VerifyPasswordResponse

Exceptions

Exception

IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse verifyPhoneNumber(IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest $postBody, array $optParams = [])

Verifies ownership of a phone number and creates/updates the user account accordingly. (relyingparty.verifyPhoneNumber)

Parameters

IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest $postBody
array $optParams

Optional parameters.

Return Value

IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse

Exceptions

Exception