EMA C++ Edition
List of all members
refinitiv::ema::access::OAuth2CredentialRenewal Class Reference

OAuth2CredentialRenewal class is used with OmmConsumer::SubmitOAuthCredentialRenewal to supply EMA with changed credentials. More...

Public Member Functions

Constructor
 OAuth2CredentialRenewal ()
  More...
 
Destructor
 ~OAuth2CredentialRenewal ()
  More...
 
Operations
OAuth2CredentialRenewalclear ()
  More...
 
OAuth2CredentialRenewaluserName (EmaString &userName)
  More...
 
OAuth2CredentialRenewalpassword (EmaString &password)
  More...
 
OAuth2CredentialRenewalnewPassword (EmaString &newPassword)
  More...
 
OAuth2CredentialRenewalclientId (EmaString &clientId)
  More...
 
OAuth2CredentialRenewalclientSecret (EmaString &clientSecret)
  More...
 
OAuth2CredentialRenewalclientJWK (EmaString &clientJWK)
  More...
 
OAuth2CredentialRenewaltokenScope (EmaString &tokenScope)
  More...
 
OAuth2CredentialRenewaltakeExclusiveSignOnControl (bool takeExclusiveSignOnControl)
  More...
 

Accessors

const EmaStringgetUserName ()
  More...
 
const EmaStringgetPassword ()
  More...
 
const EmaStringgetNewPassword ()
  More...
 
const EmaStringgetClientId ()
  More...
 
const EmaStringgetClientSecret ()
  More...
 
const EmaStringgetClientJWK ()
  More...
 
const EmaStringgetTokenScope ()
  More...
 
const bool getTakeExclusiveSignOnControl ()
  More...
 

Detailed Description

Definition at line 32 of file OAuth2CredentialRenewal.h.

Constructor & Destructor Documentation

◆ OAuth2CredentialRenewal()

refinitiv::ema::access::OAuth2CredentialRenewal::OAuth2CredentialRenewal ( )

Create an OAuth2CredentialRenewal for use with OmmConsumer::SubmitOAuthCredentialRenewal

◆ ~OAuth2CredentialRenewal()

refinitiv::ema::access::OAuth2CredentialRenewal::~OAuth2CredentialRenewal ( )

Clear out all contained EmaString by zeroing out the memory, then free everything.

Member Function Documentation

◆ clear()

OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::clear ( )

Zeros out and clears all allocated EMAStrings in the class.

Returns
reference to this object

◆ clientId()

OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::clientId ( EmaString 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]clientIdthe clientId
Returns
reference to this object

◆ clientJWK()

OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::clientJWK ( EmaString 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]clientJWKthe client JWK
Returns
reference to this object

◆ clientSecret()

OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::clientSecret ( EmaString 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]clientSecretspecifies 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()

OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::newPassword ( EmaString 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]newPasswordthe password
Returns
reference to this object

◆ password()

OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::password ( EmaString 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
[in]passwordthe password
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]takeExclusiveSignOnControlthe takeExclusiveSignOnControl value
Returns
reference to this object

◆ tokenScope()

OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::tokenScope ( EmaString tokenScope)

Specifies the token scope to limit the scope of generated token from the token service. Optional.

Parameters
[in]clientSecretthe clientSecret.
Returns
reference to this object

◆ userName()

OAuth2CredentialRenewal& refinitiv::ema::access::OAuth2CredentialRenewal::userName ( EmaString userName)

Specifies the user name required to authorize with the RDP token service. Mandatory for V1 oAuth Password Credentials logins

Parameters
[in]userNamethe user name
Returns
reference to this object