Documentation

Google_Service_IdentityToolkit_Resource_Relyingparty extends Google_Service_Resource
in package

Application

The "relyingparty" collection of methods.

Typical usage is: $identitytoolkitService = new Google_Service_IdentityToolkit(...); $relyingparty = $identitytoolkitService->relyingparty;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createAuthUri() : Google_Service_IdentityToolkit_CreateAuthUriResponse: Creates the URI used by the IdP to authenticate the user.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
deleteAccount() : Google_Service_IdentityToolkit_DeleteAccountResponse: Delete user account. (relyingparty.deleteAccount)
downloadAccount() : Google_Service_IdentityToolkit_DownloadAccountResponse: Batch download user accounts. (relyingparty.downloadAccount)
emailLinkSignin() : Google_Service_IdentityToolkit_EmailLinkSigninResponse: Reset password for a user. (relyingparty.emailLinkSignin)
getAccountInfo() : Google_Service_IdentityToolkit_GetAccountInfoResponse: Returns the account info. (relyingparty.getAccountInfo)
getOobConfirmationCode() : Google_Service_IdentityToolkit_GetOobConfirmationCodeResponse: Get a code for user action confirmation.
getProjectConfig() : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetProjectConfigResponse: Get project configuration. (relyingparty.getProjectConfig)
getPublicKeys() : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetPublicKeysResponse: Get token signing public key. (relyingparty.getPublicKeys)
getRecaptchaParam() : Google_Service_IdentityToolkit_GetRecaptchaParamResponse: Get recaptcha secure param. (relyingparty.getRecaptchaParam)
resetPassword() : Google_Service_IdentityToolkit_ResetPasswordResponse: Reset password for a user. (relyingparty.resetPassword)
sendVerificationCode() : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySendVerificationCodeResponse: Send SMS verification code. (relyingparty.sendVerificationCode)
setAccountInfo() : Google_Service_IdentityToolkit_SetAccountInfoResponse: Set account info for a user. (relyingparty.setAccountInfo)
setProjectConfig() : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetProjectConfigResponse: Set project configuration. (relyingparty.setProjectConfig)
signOutUser() : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySignOutUserResponse: Sign out user. (relyingparty.signOutUser)
signupNewUser() : Google_Service_IdentityToolkit_SignupNewUserResponse: Signup new user. (relyingparty.signupNewUser)
uploadAccount() : Google_Service_IdentityToolkit_UploadAccountResponse: Batch upload existing user accounts. (relyingparty.uploadAccount)
verifyAssertion() : Google_Service_IdentityToolkit_VerifyAssertionResponse: Verifies the assertion returned by the IdP. (relyingparty.verifyAssertion)
verifyCustomToken() : Google_Service_IdentityToolkit_VerifyCustomTokenResponse: Verifies the developer asserted ID token. (relyingparty.verifyCustomToken)
verifyPassword() : Google_Service_IdentityToolkit_VerifyPasswordResponse: Verifies the user entered password. (relyingparty.verifyPassword)
verifyPhoneNumber() : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse: Verifies ownership of a phone number and creates/updates the user account accordingly. (relyingparty.verifyPhoneNumber)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createAuthUri()

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


    public
                createAuthUri(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyCreateAuthUriRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_CreateAuthUriResponse

(relyingparty.createAuthUri)

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyCreateAuthUriRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_CreateAuthUriResponse —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

deleteAccount()

Delete user account. (relyingparty.deleteAccount)


    public
                deleteAccount(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyDeleteAccountRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_DeleteAccountResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyDeleteAccountRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_DeleteAccountResponse —

downloadAccount()

Batch download user accounts. (relyingparty.downloadAccount)


    public
                downloadAccount(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyDownloadAccountRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_DownloadAccountResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyDownloadAccountRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_DownloadAccountResponse —

emailLinkSignin()

Reset password for a user. (relyingparty.emailLinkSignin)


    public
                emailLinkSignin(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyEmailLinkSigninRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_EmailLinkSigninResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyEmailLinkSigninRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_EmailLinkSigninResponse —

getAccountInfo()

Returns the account info. (relyingparty.getAccountInfo)


    public
                getAccountInfo(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetAccountInfoRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_GetAccountInfoResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetAccountInfoRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_GetAccountInfoResponse —

getOobConfirmationCode()

Get a code for user action confirmation.


    public
                getOobConfirmationCode(Google_Service_IdentityToolkit_Relyingparty $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_GetOobConfirmationCodeResponse

(relyingparty.getOobConfirmationCode)

Parameters

$postBody : Google_Service_IdentityToolkit_Relyingparty
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_GetOobConfirmationCodeResponse —

getProjectConfig()

Get project configuration. (relyingparty.getProjectConfig)


    public
                getProjectConfig([array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetProjectConfigResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetProjectConfigResponse —

getPublicKeys()

Get token signing public key. (relyingparty.getPublicKeys)


    public
                getPublicKeys([array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetPublicKeysResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetPublicKeysResponse —

getRecaptchaParam()

Get recaptcha secure param. (relyingparty.getRecaptchaParam)


    public
                getRecaptchaParam([array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_GetRecaptchaParamResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_GetRecaptchaParamResponse —

resetPassword()

Reset password for a user. (relyingparty.resetPassword)


    public
                resetPassword(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyResetPasswordRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_ResetPasswordResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyResetPasswordRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_ResetPasswordResponse —

sendVerificationCode()

Send SMS verification code. (relyingparty.sendVerificationCode)


    public
                sendVerificationCode(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySendVerificationCodeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySendVerificationCodeResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySendVerificationCodeRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySendVerificationCodeResponse —

setAccountInfo()

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


    public
                setAccountInfo(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetAccountInfoRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_SetAccountInfoResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetAccountInfoRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_SetAccountInfoResponse —

setProjectConfig()

Set project configuration. (relyingparty.setProjectConfig)


    public
                setProjectConfig(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetProjectConfigRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetProjectConfigResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetProjectConfigRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetProjectConfigResponse —

signOutUser()

Sign out user. (relyingparty.signOutUser)


    public
                signOutUser(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySignOutUserRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySignOutUserResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySignOutUserRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySignOutUserResponse —

signupNewUser()

Signup new user. (relyingparty.signupNewUser)


    public
                signupNewUser(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySignupNewUserRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_SignupNewUserResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySignupNewUserRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_SignupNewUserResponse —

uploadAccount()

Batch upload existing user accounts. (relyingparty.uploadAccount)


    public
                uploadAccount(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyUploadAccountRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_UploadAccountResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyUploadAccountRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_UploadAccountResponse —

verifyAssertion()

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


    public
                verifyAssertion(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyAssertionRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_VerifyAssertionResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyAssertionRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_VerifyAssertionResponse —

verifyCustomToken()

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


    public
                verifyCustomToken(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyCustomTokenRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_VerifyCustomTokenResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyCustomTokenRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_VerifyCustomTokenResponse —

verifyPassword()

Verifies the user entered password. (relyingparty.verifyPassword)


    public
                verifyPassword(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPasswordRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_VerifyPasswordResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPasswordRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_VerifyPasswordResponse —

verifyPhoneNumber()

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


    public
                verifyPhoneNumber(Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse

Parameters

$postBody : Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPhoneNumberRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPhoneNumberResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —