OAuth2Credential class is used with OmmConsumer::SubmitOAuthCredentialRenewal to supply EMA with changed credentials.
More...
Definition at line 32 of file OAuth2Credential.h.
◆ OAuth2Credential()
refinitiv::ema::access::OAuth2Credential::OAuth2Credential |
( |
| ) |
|
Create an OAuth2Credential for use with OmmConsumer::SubmitOAuthCredentialRenewal
◆ ~OAuth2Credential()
refinitiv::ema::access::OAuth2Credential::~OAuth2Credential |
( |
| ) |
|
Clear out all contained EmaString by zeroing out the memory, then free everything.
◆ audience()
Specifies the audience claim for the JWT. Optional and only used for V2 Client Credentials with JWT.
- Parameters
-
[in] | audience | specifies the audience claim string |
- Returns
- reference to this object
◆ channelList()
Specifies the connections associated with this credential set. This is a comma separated string with the name of the connections. If this is blank, then these credentials will apply to all channels that have session management enabled that do not match with any other configured oAuth2 credentials.
- Parameters
-
[in] | connectionList | specifies the list of connections associated with this set of credentials. |
- Returns
- reference to this object
◆ clear()
Zeros out and clears all allocated EMAStrings in the class.
- Returns
- reference to this object
◆ clientId()
Specifies the clientID used for RDP token service. Mandatory, used to specify Application ID obtained from App Generator for V1 oAuth Password Credentials, or to specify Service Account username for V2 Client Credentials and V2 Client Credentials with JWT Logins.
- Parameters
-
[in] | clientId | specifies the clientId |
- Returns
- reference to this object
◆ clientJWK()
Specifies the JWK formatted private key used to create the JWT. The JWT is used to authenticate with the RDP token service. Mandatory for V2 logins with client JWT logins
- Parameters
-
[in] | clientJWK | specifies the JWK formatted private key |
- Returns
- reference to this object
◆ clientSecret()
Specifies the clientSecret, also known as the Service Account password, used to authenticate with RDP token service. Mandatory for V2 Client Credentials Logins and used in conjunction with clientID.
- Parameters
-
[in] | clientSecret | specifies the clientSecret |
- Returns
- reference to this object
◆ getAudience()
const EmaString& refinitiv::ema::access::OAuth2Credential::getAudience |
( |
| ) |
|
Gets the audience claim for the JWT. Optional and only used for V2 Client Credentials with JWT.
- Returns
- audience
◆ getChannelList()
const EmaString& refinitiv::ema::access::OAuth2Credential::getChannelList |
( |
| ) |
|
Gets the connections associated with this credential set. This is a comma separated string with the name of the connections. If this is blank, then these credentials will apply to all channels that have session management enabled that do not match with any other configured oAuth2 credentials.
- Returns
- channe list
◆ getClientId()
const EmaString& refinitiv::ema::access::OAuth2Credential::getClientId |
( |
| ) |
|
Gets the clientID used for RDP token service. Mandatory, used to specify Application ID obtained from App Generator for V1 oAuth Password Credentials, or to specify Service Account username for V2 Client Credentials and V2 Client Credentials with JWT Logins.
- Returns
- client id
◆ getClientJWK()
const EmaString& refinitiv::ema::access::OAuth2Credential::getClientJWK |
( |
| ) |
|
Gets the JWK formatted private key used to create the JWT. The JWT is used to authenticate with the RDP token service. Mandatory for V2 logins with client JWT logins
- Returns
- client WJK
◆ getClientSecret()
const EmaString& refinitiv::ema::access::OAuth2Credential::getClientSecret |
( |
| ) |
|
Gets the clientSecret, also known as the Service Account password, used to authenticate with RDP token service. Mandatory for V2 Client Credentials Logins and used in conjunction with clientID.
- Returns
- client secret
◆ getPassword()
const EmaString& refinitiv::ema::access::OAuth2Credential::getPassword |
( |
| ) |
|
Gets the password for user name used to get access token. Mandatory for V1 oAuth Password Credentials logins
- Returns
- password
◆ getTakeExclusiveSignOnControl()
const bool refinitiv::ema::access::OAuth2Credential::getTakeExclusiveSignOnControl |
( |
| ) |
|
Gets the take exclusive sign on control value. If set to true, other applications using the same credentials will be force signed-out. Optional and only used for V1 oAuth Password Credentials logins.
- Returns
- takeExclusiveSignOnControl value
◆ getTokenScope()
const EmaString& refinitiv::ema::access::OAuth2Credential::getTokenScope |
( |
| ) |
|
Gets the token scope to limit the scope of generated token from the token service. Optional.
- Returns
- token scope
◆ getUserName()
const EmaString& refinitiv::ema::access::OAuth2Credential::getUserName |
( |
| ) |
|
Gets the user name required to authorize with the RDP token service. Mandatory for V1 oAuth Password Credentials logins.
- Returns
- user name
◆ password()
Specifies the password for user name used to get access token. Mandatory for V1 oAuth Password Credentials logins
- Parameters
-
[in] | password | specifies the password |
- Returns
- reference to this object
◆ takeExclusiveSignOnControl()
OAuth2Credential& refinitiv::ema::access::OAuth2Credential::takeExclusiveSignOnControl |
( |
bool |
takeExclusiveSignOnControl | ) |
|
Specifies the take exclusive sign on control value. If set to true, other applications using the same credentials will be force signed-out. Optional and only used for V1 oAuth Password Credentials logins.
- Parameters
-
[in] | takeExclusiveSignOnControl | specifies the takeExclusiveSignOnControl value |
- Returns
- reference to this object
◆ tokenScope()
Specifies the token scope to limit the scope of generated token from the token service. Optional.
- Parameters
-
[in] | clientSecret | specifies the clientSecret |
- Returns
- reference to this object
◆ userName()
Specifies the user name required to authorize with the RDP token service. Mandatory for V1 oAuth Password Credentials logins.
- Parameters
-
[in] | userName | specifies the user name |
- Returns
- reference to this object