Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_IdentityToolkit_Relyingparty_Resource Class Reference

The "relyingparty" collection of methods. More...

Inheritance diagram for Google_Service_IdentityToolkit_Relyingparty_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 createAuthUri (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyCreateAuthUriRequest $postBody, $optParams=array())
 Creates the URI used by the IdP to authenticate the user.
 
 deleteAccount (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyDeleteAccountRequest $postBody, $optParams=array())
 Delete user account.
 
 downloadAccount (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyDownloadAccountRequest $postBody, $optParams=array())
 Batch download user accounts.
 
 getAccountInfo (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetAccountInfoRequest $postBody, $optParams=array())
 Returns the account info.
 
 getOobConfirmationCode (Google_Service_IdentityToolkit_Relyingparty $postBody, $optParams=array())
 Get a code for user action confirmation.
 
 getPublicKeys ($optParams=array())
 Get token signing public key.
 
 getRecaptchaParam ($optParams=array())
 Get recaptcha secure param.
 
 resetPassword (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyResetPasswordRequest $postBody, $optParams=array())
 Reset password for a user.
 
 setAccountInfo (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetAccountInfoRequest $postBody, $optParams=array())
 Set account info for a user.
 
 uploadAccount (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyUploadAccountRequest $postBody, $optParams=array())
 Batch upload existing user accounts.
 
 verifyAssertion (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyAssertionRequest $postBody, $optParams=array())
 Verifies the assertion returned by the IdP.
 
 verifyPassword (Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPasswordRequest $postBody, $optParams=array())
 Verifies the user entered password.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "relyingparty" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ createAuthUri()

Google_Service_IdentityToolkit_Relyingparty_Resource::createAuthUri ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyCreateAuthUriRequest $postBody,
$optParams = array() )

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

(relyingparty.createAuthUri)

Parameters
Google_IdentitytoolkitRelyingpartyCreateAuthUriRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_CreateAuthUriResponse

◆ deleteAccount()

Google_Service_IdentityToolkit_Relyingparty_Resource::deleteAccount ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyDeleteAccountRequest $postBody,
$optParams = array() )

Delete user account.

(relyingparty.deleteAccount)

Parameters
Google_IdentitytoolkitRelyingpartyDeleteAccountRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_DeleteAccountResponse

◆ downloadAccount()

Google_Service_IdentityToolkit_Relyingparty_Resource::downloadAccount ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyDownloadAccountRequest $postBody,
$optParams = array() )

Batch download user accounts.

(relyingparty.downloadAccount)

Parameters
Google_IdentitytoolkitRelyingpartyDownloadAccountRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_DownloadAccountResponse

◆ getAccountInfo()

Google_Service_IdentityToolkit_Relyingparty_Resource::getAccountInfo ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetAccountInfoRequest $postBody,
$optParams = array() )

Returns the account info.

(relyingparty.getAccountInfo)

Parameters
Google_IdentitytoolkitRelyingpartyGetAccountInfoRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_GetAccountInfoResponse

◆ getOobConfirmationCode()

Google_Service_IdentityToolkit_Relyingparty_Resource::getOobConfirmationCode ( Google_Service_IdentityToolkit_Relyingparty $postBody,
$optParams = array() )

Get a code for user action confirmation.

(relyingparty.getOobConfirmationCode)

Parameters
Google_Relyingparty$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_GetOobConfirmationCodeResponse

◆ getPublicKeys()

Google_Service_IdentityToolkit_Relyingparty_Resource::getPublicKeys ( $optParams = array())

Get token signing public key.

(relyingparty.getPublicKeys)

Parameters
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyGetPublicKeysResponse

◆ getRecaptchaParam()

Google_Service_IdentityToolkit_Relyingparty_Resource::getRecaptchaParam ( $optParams = array())

Get recaptcha secure param.

(relyingparty.getRecaptchaParam)

Parameters
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_GetRecaptchaParamResponse

◆ resetPassword()

Google_Service_IdentityToolkit_Relyingparty_Resource::resetPassword ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyResetPasswordRequest $postBody,
$optParams = array() )

Reset password for a user.

(relyingparty.resetPassword)

Parameters
Google_IdentitytoolkitRelyingpartyResetPasswordRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_ResetPasswordResponse

◆ setAccountInfo()

Google_Service_IdentityToolkit_Relyingparty_Resource::setAccountInfo ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartySetAccountInfoRequest $postBody,
$optParams = array() )

Set account info for a user.

(relyingparty.setAccountInfo)

Parameters
Google_IdentitytoolkitRelyingpartySetAccountInfoRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_SetAccountInfoResponse

◆ uploadAccount()

Google_Service_IdentityToolkit_Relyingparty_Resource::uploadAccount ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyUploadAccountRequest $postBody,
$optParams = array() )

Batch upload existing user accounts.

(relyingparty.uploadAccount)

Parameters
Google_IdentitytoolkitRelyingpartyUploadAccountRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_UploadAccountResponse

◆ verifyAssertion()

Google_Service_IdentityToolkit_Relyingparty_Resource::verifyAssertion ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyAssertionRequest $postBody,
$optParams = array() )

Verifies the assertion returned by the IdP.

(relyingparty.verifyAssertion)

Parameters
Google_IdentitytoolkitRelyingpartyVerifyAssertionRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_VerifyAssertionResponse

◆ verifyPassword()

Google_Service_IdentityToolkit_Relyingparty_Resource::verifyPassword ( Google_Service_IdentityToolkit_IdentitytoolkitRelyingpartyVerifyPasswordRequest $postBody,
$optParams = array() )

Verifies the user entered password.

(relyingparty.verifyPassword)

Parameters
Google_IdentitytoolkitRelyingpartyVerifyPasswordRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_IdentityToolkit_VerifyPasswordResponse

The documentation for this class was generated from the following file: