ServiceEndpointDiscoveryOption is used to specify query options for ServiceEndpointDiscovery::registerClient().
More...
◆ DataformatProtocol
Enumerator |
---|
UnknownDataFormatEnum | Indicates undefined data format protocol
|
RwfEnum | Indicates RWF data format protocol
|
Json2Enum | Indicates tr_json2 data format protocol
|
Definition at line 42 of file ServiceEndpointDiscoveryOption.h.
◆ TransportProtocol
Enumerator |
---|
UnknownTransportEnum | Indicates undefined transport protocol
|
TcpEnum | Indicates TCP transport protocol
|
WebsocketEnum | Indicates Websocket transport protocol
|
Definition at line 35 of file ServiceEndpointDiscoveryOption.h.
◆ ServiceEndpointDiscoveryOption()
refinitiv::ema::access::ServiceEndpointDiscoveryOption::ServiceEndpointDiscoveryOption |
( |
| ) |
|
◆ ~ServiceEndpointDiscoveryOption()
virtual refinitiv::ema::access::ServiceEndpointDiscoveryOption::~ServiceEndpointDiscoveryOption |
( |
| ) |
|
|
virtual |
◆ audience()
Specifies the audience claim used by OAuth client to authenticate to the Authorization Server. This is optional for OAuth V2 JWT interactions.
- Parameters
-
[in] | audience | specifies the client audience claim |
- Returns
- reference to this object
◆ clear()
◆ 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 client ID |
- Returns
- reference to this object
◆ clientJWK()
Specifies the clientJWK. This is used for login V2
- Parameters
-
[in] | clientJWK | specifies the client JWK for oAuth2 interactions. |
- 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 a client secret. |
- Returns
- reference to this object
◆ dataFormat()
Specifies a data format protocol to get endpoints according to the protocol.
- Parameters
-
[in] | dataFormat | specifies a data format protocol |
- Returns
- reference to this object
◆ password()
Specifies the password associated with the username for sending authorization request with the token service.
- Parameters
-
[in] | password | specifies password on login request |
- Returns
- reference to this object
◆ proxyDomain()
Specifies a proxy domain of the user to perform authenticate.
- Parameters
-
[in] | proxyDomain | specifies a proxy domain |
- Returns
- reference to this object \ Needed for NTLM or for Negotiate/Kerberos or for Kerberos authentication protocols.
◆ proxyHostName()
Specifies a proxy server hostname.
- Parameters
-
[in] | proxyHostName | specifies a proxy server |
- Returns
- reference to this object
◆ proxyPassword()
Specifies a password to perform authorization with a proxy server.
- Parameters
-
[in] | proxyPassword | specifies a proxy password |
- Returns
- reference to this object
◆ proxyPort()
Specifies a proxy server port.
- Parameters
-
[in] | proxyPort | specifies a proxy port |
- Returns
- reference to this object
◆ proxyUserName()
Specifies a username to perform authorization with a proxy server.
- Parameters
-
[in] | proxyUserName | specifies a proxy user name |
- Returns
- reference to this object
◆ takeExclusiveSignOnControl()
ServiceEndpointDiscoveryOption& refinitiv::ema::access::ServiceEndpointDiscoveryOption::takeExclusiveSignOnControl |
( |
bool |
takeExclusiveSignOnControl = true | ) |
|
Specifies optionally the exclusive sign on control to force sign-out of other applications using the same credentials.
- Parameters
-
[in] | takeExclusiveSignOnControl | the exclusive sign on control. |
- Returns
- reference to this object
◆ tokenScope()
Specifies optionally token scope to limit the scope of generated token from the token service.
- Parameters
-
[in] | tokenScope | specifies a token scope |
- Returns
- reference to this object
◆ transport()
Specifies a transport protocol to get endpoints according to the protocol.
- Parameters
-
[in] | transport | specifies a transport protocol |
- Returns
- reference to this object
◆ transprot()
- Deprecated:
- the transport() function should be used instead. Specifies a transport protocol to get endpoints according to the protocol.
- Parameters
-
[in] | transport | specifies a transport protocol |
- Returns
- reference to this object
◆ username()
Specifies the username for sending authorization request with the token service.
- Parameters
-
[in] | username | specifies name used on login request |
- Returns
- reference to this object