SsoSession¶
Definition¶
Extends¶
Extended By¶
None
Description¶
SSO Session
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| SsoSession | getAccessToken() | String | Returns the Access Token issued by the SSO Provider. See accessToken() for convenience method to get current sso access token. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| SsoSession | getProperties() | Map | Returns a map of all custom properties, see getProperty(..) if you looking for a particular property. |
| SsoSession | getProperty(key) | Object | Returns a custom property, this will be faster than using getProperties() when looking for just a single property. |
| SsoSession | getProvider() | String | Returns the name of the provider, likely a company name. |
| SsoSession | getProviderUrl() | String | Returns the provider's access base URL. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
getAccessToken()¶
String SsoSession::getAccessToken()
Description¶
Returns the Access Token issued by the SSO Provider. See accessToken() for convenience method to get current sso access token.
getProperties()¶
Map SsoSession::getProperties()
Description¶
Returns a map of all custom properties, see getProperty(..) if you looking for a particular property.
getProperty(key)¶
Object SsoSession::getProperty(String key)
Description¶
Returns a custom property, this will be faster than using getProperties() when looking for just a single property.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| key | String | key of the property to get |
getProvider()¶
String SsoSession::getProvider()
Description¶
Returns the name of the provider, likely a company name.
getProviderUrl()¶
String SsoSession::getProviderUrl()
Description¶
Returns the provider's access base URL.