Class OpenIdTokeninfo

Class OpenIdTokeninfo

Token grant resource

PayPal\Common\PayPalModel

Extended by

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

Extended by

PayPal\Api\OpenIdTokeninfo

Namespace: PayPal\Api
Located at PayPal/Api/OpenIdTokeninfo.php

Methods summary

`public PayPal\Api\OpenIdTokeninfo`	# `setScope( string $scope )` OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. Parameters `$scope` Returns `PayPal\Api\OpenIdTokeninfo`
`public string`	# `getScope( )` OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. Returns string
`public PayPal\Api\OpenIdTokeninfo`	# `setAccessToken( string $access_token )` The access token issued by the authorization server. The access token issued by the authorization server. Parameters `$access_token` Returns `PayPal\Api\OpenIdTokeninfo`
`public string`	# `getAccessToken( )` The access token issued by the authorization server. The access token issued by the authorization server. Returns string
`public PayPal\Api\OpenIdTokeninfo`	# `setRefreshToken( string $refresh_token )` The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in OAuth2.0 RFC6749 in Section 6. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in OAuth2.0 RFC6749 in Section 6. Parameters `$refresh_token` Returns `PayPal\Api\OpenIdTokeninfo`
`public string`	# `getRefreshToken( )` The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in OAuth2.0 RFC6749 in Section 6. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in OAuth2.0 RFC6749 in Section 6. Returns string
`public PayPal\Api\OpenIdTokeninfo`	# `setTokenType( string $token_type )` The type of the token issued as described in OAuth2.0 RFC6749 (Section 7.1). Value is case insensitive. The type of the token issued as described in OAuth2.0 RFC6749 (Section 7.1). Value is case insensitive. Parameters `$token_type` Returns `PayPal\Api\OpenIdTokeninfo`
`public string`	# `getTokenType( )` The type of the token issued as described in OAuth2.0 RFC6749 (Section 7.1). Value is case insensitive. The type of the token issued as described in OAuth2.0 RFC6749 (Section 7.1). Value is case insensitive. Returns string
`public PayPal\Api\OpenIdTokeninfo`	# `setIdToken( string $id_token )` The id_token is a session token assertion that denotes the user's authentication status The id_token is a session token assertion that denotes the user's authentication status Parameters `$id_token` Returns `PayPal\Api\OpenIdTokeninfo`
`public string`	# `getIdToken( )` The id_token is a session token assertion that denotes the user's authentication status The id_token is a session token assertion that denotes the user's authentication status Returns string
`public PayPal\Api\OpenIdTokeninfo`	# `setExpiresIn( integer $expires_in )` The lifetime in seconds of the access token. The lifetime in seconds of the access token. Parameters `$expires_in` Returns `PayPal\Api\OpenIdTokeninfo`
`public integer`	# `getExpiresIn( )` The lifetime in seconds of the access token. The lifetime in seconds of the access token. Returns integer
`public static PayPal\Api\OpenIdTokeninfo`	# `createFromAuthorizationCode( array $params, string $clientId = null, string $clientSecret = null, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Creates an Access Token from an Authorization Code. Creates an Access Token from an Authorization Code. Parameters `$params` (allowed values are client_id, client_secret, grant_type, code and redirect_uri) (required) client_id from developer portal (required) client_secret from developer portal (required) code is Authorization code previously received from the authorization server (required) redirect_uri Redirection endpoint that must match the one provided during the authorization request that ended in receiving the authorization code. (optional) grant_type is the Token grant type. Defaults to authorization_code `$clientId` `$clientSecret` `$apiContext` Optional API Context `$restCall` Returns `PayPal\Api\OpenIdTokeninfo` Path /v1/identity/openidconnect/tokenservice
`public PayPal\Api\OpenIdTokeninfo`	# `createFromRefreshToken( array $params, APIContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Creates an Access Token from an Refresh Token. Creates an Access Token from an Refresh Token. Parameters `$params` (allowed values are grant_type and scope) (required) client_id from developer portal (required) client_secret from developer portal (optional) refresh_token refresh token. If one is not passed, refresh token from the current object is used. (optional) grant_type is the Token grant type. Defaults to refresh_token (optional) scope is an array that either the same or a subset of the scope passed to the authorization request `$apiContext` Optional API Context `$restCall` Returns `PayPal\Api\OpenIdTokeninfo` Path /v1/identity/openidconnect/tokenservice

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel