OAuth2CredentialRenewal class is used with OmmConsumer::SubmitOAuthCredentialRenewal to supply EMA with changed credentials.
More...
Definition at line 32 of file OAuth2CredentialRenewal.h.
◆ OAuth2CredentialRenewal()
refinitiv::ema::access::OAuth2CredentialRenewal::OAuth2CredentialRenewal |
( |
| ) |
|
◆ ~OAuth2CredentialRenewal()
refinitiv::ema::access::OAuth2CredentialRenewal::~OAuth2CredentialRenewal |
( |
| ) |
|
Clear out all contained EmaString by zeroing out the memory, then free everything.
◆ 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
-
- 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 | the client JWK |
- 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
◆ getClientId()
const EmaString& refinitiv::ema::access::OAuth2CredentialRenewal::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::OAuth2CredentialRenewal::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 JWK
◆ getClientSecret()
const EmaString& refinitiv::ema::access::OAuth2CredentialRenewal::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
◆ getNewPassword()
const EmaString& refinitiv::ema::access::OAuth2CredentialRenewal::getNewPassword |
( |
| ) |
|
Gets the newPassword. This is only used for V1 oAuth Password Credentials only if the password has changed since the last login attempt. /p If the password has changed, the previous password should be specified with OAuth2CredentialRenewal::password, and the new password should be set with this function.
- Returns
- new password
◆ getPassword()
const EmaString& refinitiv::ema::access::OAuth2CredentialRenewal::getPassword |
( |
| ) |
|
Gets the password for user name used to get an access token and a refresh token. Mandatory, used for V1 oAuth Password Credential logins.
- Returns
- password
◆ getTakeExclusiveSignOnControl()
const bool refinitiv::ema::access::OAuth2CredentialRenewal::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::OAuth2CredentialRenewal::getTokenScope |
( |
| ) |
|
Specifies the token scope to limit the scope of generated token from the token service. Optional.
- Returns
- token scope
◆ getUserName()
const EmaString& refinitiv::ema::access::OAuth2CredentialRenewal::getUserName |
( |
| ) |
|
Gets the user name required to authorize with the RDP token service. Mandatory for V1 oAuth Password Credentials logins
- Returns
- user name
◆ newPassword()
Specifies the new Password. This is only used for V1 oAuth Password Credentials only if the password has changed since the last login attempt. /p If the password has changed, the previous password should be specified with OAuth2CredentialRenewal::password, and the new password should be set with this function.
- Parameters
-
[in] | newPassword | the password |
- Returns
- reference to this object
◆ password()
Specifies the password for user name used to get an access token and a refresh token. Mandatory, used for V1 oAuth Password Credential logins. If the password has changed, this will be the previous password.
- Parameters
-
- Returns
- reference to this object
◆ takeExclusiveSignOnControl()
OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::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 | 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 | 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 | the user name |
- Returns
- reference to this object