public
PayPal\Api\OpenIdUserinfo
|
#
setUserId( string $user_id )
Subject - Identifier for the End-User at the Issuer.
Subject - Identifier for the End-User at the Issuer.
Parameters
Returns
|
public
string
|
#
getUserId( )
Subject - Identifier for the End-User at the Issuer.
Subject - Identifier for the End-User at the Issuer.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setSub( string $sub )
Subject - Identifier for the End-User at the Issuer.
Subject - Identifier for the End-User at the Issuer.
Parameters
Returns
|
public
string
|
#
getSub( )
Subject - Identifier for the End-User at the Issuer.
Subject - Identifier for the End-User at the Issuer.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setName( string $name )
End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
Parameters
Returns
|
public
string
|
#
getName( )
End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setGivenName( string $given_name )
Given name(s) or first name(s) of the End-User
Given name(s) or first name(s) of the End-User
Parameters
Returns
|
public
string
|
#
getGivenName( )
Given name(s) or first name(s) of the End-User
Given name(s) or first name(s) of the End-User
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setFamilyName( string $family_name )
Surname(s) or last name(s) of the End-User.
Surname(s) or last name(s) of the End-User.
Parameters
Returns
|
public
string
|
#
getFamilyName( )
Surname(s) or last name(s) of the End-User.
Surname(s) or last name(s) of the End-User.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setMiddleName( string $middle_name )
Middle name(s) of the End-User.
Middle name(s) of the End-User.
Parameters
Returns
|
public
string
|
#
getMiddleName( )
Middle name(s) of the End-User.
Middle name(s) of the End-User.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setPicture( string $picture )
URL of the End-User's profile picture.
URL of the End-User's profile picture.
Parameters
Returns
|
public
string
|
#
getPicture( )
URL of the End-User's profile picture.
URL of the End-User's profile picture.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setEmail( string $email )
End-User's preferred e-mail address.
End-User's preferred e-mail address.
Parameters
Returns
|
public
string
|
#
getEmail( )
End-User's preferred e-mail address.
End-User's preferred e-mail address.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setEmailVerified( boolean $email_verified )
True if the End-User's e-mail address has been verified; otherwise false.
True if the End-User's e-mail address has been verified; otherwise false.
Parameters
Returns
|
public
boolean
|
#
getEmailVerified( )
True if the End-User's e-mail address has been verified; otherwise false.
True if the End-User's e-mail address has been verified; otherwise false.
Returns
boolean
|
public
PayPal\Api\OpenIdUserinfo
|
#
setGender( string $gender )
End-User's gender.
Parameters
Returns
|
public
string
|
|
public
PayPal\Api\OpenIdUserinfo
|
#
setBirthday( string $birthday )
End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
Parameters
Returns
|
public
string
|
#
getBirthday( )
End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
End-User's birthday, represented as an YYYY-MM-DD format. They year MAY be 0000, indicating it is omited. To represent only the year, YYYY format would be used.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setZoneinfo( string $zoneinfo )
Time zone database representing the End-User's time zone
Time zone database representing the End-User's time zone
Parameters
Returns
|
public
string
|
#
getZoneinfo( )
Time zone database representing the End-User's time zone
Time zone database representing the End-User's time zone
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setLocale( string $locale )
End-User's locale.
Parameters
Returns
|
public
string
|
|
public
PayPal\Api\OpenIdUserinfo
|
#
setLanguage( string $language )
End-User's language.
Parameters
Returns
|
public
string
|
|
public
PayPal\Api\OpenIdUserinfo
|
#
setVerified( boolean $verified )
End-User's verified status.
End-User's verified status.
Parameters
Returns
|
public
boolean
|
#
getVerified( )
End-User's verified status.
End-User's verified status.
Returns
boolean
|
public
PayPal\Api\OpenIdUserinfo
|
#
setPhoneNumber( string $phone_number )
End-User's preferred telephone number.
End-User's preferred telephone number.
Parameters
Returns
|
public
string
|
#
getPhoneNumber( )
End-User's preferred telephone number.
End-User's preferred telephone number.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
|
public
PayPal\Api\OpenIdAddress
|
#
getAddress( )
End-User's preferred address.
End-User's preferred address.
Returns
|
public
PayPal\Api\OpenIdUserinfo
|
|
public
boolean
|
|
public
PayPal\Api\OpenIdUserinfo
|
|
public
string
|
|
public
PayPal\Api\OpenIdUserinfo
|
#
setAgeRange( string $age_range )
Account holder age range.
Account holder age range.
Parameters
Returns
|
public
string
|
#
getAgeRange( )
Account holder age range.
Account holder age range.
Returns
string
|
public
PayPal\Api\OpenIdUserinfo
|
#
setPayerId( string $payer_id )
Account payer identifier.
Account payer identifier.
Parameters
Returns
|
public
string
|
#
getPayerId( )
Account payer identifier.
Account payer identifier.
Returns
string
|
public static
PayPal\Api\OpenIdUserinfo
|
#
getUserinfo( array $params, PayPal\Rest\ApiContext $apiContext = null, PayPalRestCall $restCall = null )
returns user details
Parameters
- $params
(allowed values are access_token)
access_token - access token from the createFromAuthorizationCode / createFromRefreshToken calls
- $apiContext
- Optional API Context
- $restCall
Returns
Path
/v1/identity/openidconnect/userinfo
|