Jump to: navigation, search

service-client-api.accepted-web-content-origins

Section: interaction-workspace
Default Value: No default value
Valid Values: A comma-separated value list of URL or '*'
Changes Take Effect: After the next platform configuration refresh interval.
Introduced: 9.0.000.31

Specifies the list of granted origins and allowed APIs that are used in the web extension views. You can filter requested API with the following self-explanatory keywords:

  • 'agent.get'
  • 'agent.getStateList'
  • 'agent.setState'
  • 'agent.getState'
  • 'interaction.getInteractions'
  • 'interaction.getByInteractionId'
  • 'interaction.getByBundleId'
  • 'interaction.getByCaseId'
  • 'interaction.setUserData'
  • 'interaction.deleteUserData'
  • 'system.closeToast'
  • 'system.popupToast'
  • 'system.updateToast'
  • 'voice.dial'
  • 'voice.startCallRecording'
  • 'voice.stopCallRecording'
  • 'voice.pauseCallRecording'
  • 'voice.resumeCallRecording'
  • 'email.create'.
    For example, the value for of this option could now be: http://my-web-server0, http://my-web-server1 , http://my-web-server2 (agent.*, voice.dial), http://my-web-server3 (agent.*, interaction.*).

    In this example, all requests are allowed for the http://my-web-server0 and http://my-web-server1 domains. For the http://my-web-server2 domain, only the following requests are allowed: 'agent.get', 'agent.getStateList', 'agent.setState', 'agent.getState', 'voice.dial'. For the http://my-web-server3 domain, only the following requests are allowed:
  • 'agent.get'
  • 'agent.getStateList'
  • 'agent.setState'
  • 'agent.getState'
  • 'interaction.getInteractions'
  • 'interaction.getByInteractionId'
  • 'interaction.getByBundleId'
  • 'interaction.getByCaseId'
  • 'interaction.setUserData'
  • 'interaction.deleteUserData'.
    In addition to filtering by origin, you can filter by API with a wildcard in parentheses after the allowed origin. This option cannot be overridden and must be set in the WS_Cluster application.
(Created target blank page For Version: HTCC:9.0.0)
 
(Update with the copy of version: 9.0.0DRAFT)
 
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
=Auth Namespace=
 +
__TOC__
 +
==Methods==
 +
The Auth namespace includes the following methods:
 +
* [[AuthNamespace#getJwtToken|getJwtToken]]
 +
 
 +
===getJwtToken===
 +
To use the <tt>auth.getJwtToken</tt> endpoint, you must explicitly define the full endpoint name in the {{Optionslink|link=Options:Genesys_Web_Services:interaction-workspace:service-client-api-accepted-web-content-origins}} option. For example: <tt>service-client-api.accepted-web-content-origins = https://genesyspureengage.github.io (*, auth.getJwtToken)</tt>
 +
 
 +
{|
 +
! Signature
 +
| <static> getJwtToken(''succeeded'', ''failed'') → {''JSON object''}
 +
|-
 +
! Description
 +
| Get the JWT access token for the current session. If the token is already generated and still valid, it is returned; otherwise a new token is returned.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| succeeded
 +
| string
 +
| The callback function to use if the operation succeeded.
 +
|-
 +
| failed
 +
| string
 +
| The callback function to use if the operation failed.
 +
|}
 +
|-
 +
! Returns
 +
| JSON <tt>data</tt> object with the token and its expiration date in {{#Widget:ExtLink|link=https://en.wikipedia.org/wiki/ISO_8601|displaytext=ISO 8601 date format}}.
 +
<source lang="json">
 +
"data": {
 +
        "expiration": "2020-04-14T13:26:51.846Z",
 +
        "jwtToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImlzcyI6Imh0dHA6Ly9nd3MtY29yZS1hdXRoOjgwOTUvYXBpL2F1dGgvdjMvIiwia2lkIjoiZ3J2T1AwNmkyWkVMaEdTQWFUUnk1b2hhYjRh
 +
bEVuK3lBbkVZQm5UdXNxYyJ9.eyJpc3MiOiJodHRwOi8vZ3dzLWNvcmUtYXV0aDo4MDk1L2FwaS9hdXRoL3YzLyIsInN1YiI6InVybjpnd3MtY29yZS1hdXRoOjk3MDM5ZjkwLTM5ZDgtNDhiOC04N2U0LTE0NmQyYWQ3ZDI5OTpTSVBfNTAwMjoxMDQiLCJ1cm46Z2VuZXN5c2Nsb3VkLmNvbS9hdXRoL3YzL2lzX3NlZl9pc3N1ZWQiOiJ0cnVlIiwiZXhwIjoxNTg2ODcwODcyLCJvcmciOiJ1cm46Z3dzLWNvcmUtYXV0aDo5NzAzOWY5MC0zOWQ4LTQ4YjgtODdlNC0xNDZkMmFkN2QyOTkiLCJ1cm46Z2VuZXN5c2Nsb3VkLmNvbS9hdXRoL3YzL3VzZXJfZGV0YWlscyI6eyJzdWIiOiJ1cm46Z2VuZXN5c2Nsb3VkLmNvbTo5NzAzOWY5MC0zOWQ4LTQ4YjgtODdlNC0xNDZkMmFkN2QyOTk6U0lQXzUwMDI6MTA0IiwiYXV0aG9yaXRpZXMiOltdLCJkYmlkIjoxMDQsInByb3BlcnRpZXMiOnsiZmlyc3ROYW1lIjoiNTAwMkYiLCJsYXN0TmFtZSI6IjUwMDJMIiwiYWNjZXNzR3JvdXBzIjoiMTAzIiwidGVuYW50REJJRCI6IjEifSwiZW52aXJvbm1lbnRfaWQiOiIzMDRiMTQ4OS02ZDVlLTRlMDUtOTVmMy1hYjQ1ZDE3OGExYzIiLCJjb250YWN0X2NlbnRlcl9pZCI6Ijk3MDM5ZjkwLTM5ZDgtNDhiOC04N2U0LTE0NmQyYWQ3ZDI5OSIsInVzZXJfbmFtZSI6IlNJUF81MDAyIiwiZ2l2ZW5fbmFtZSI6IjUwMDJGIiwiZmFtaWx5X25hbWUiOiI1MDAyTCIsImVtYWlsIjoiU0lQXzUwMDIifX0.dtBeVDvR13_yBIMFasBLzu9oX9R8PxogdBGZGeh05wX-89aZVr32-6TscaqWS6CrAh9l9TuaXrReJxVzcJ-2MNlUGNVLE7aTsECz0ISxsbgZtQxENbAwiwgYPA8iMJV124aISKVbDQGAgao8SSXP097lgWMnd1S1QTd3_DiibAf6QU9NVXbWACt7oU2s9TO_MH6gn2dZ0Kymcpxj2U6jLNlB3hcd04qasCpt_NAzYR4U3v1IXVYYCGKjOz0p9eXd0aR3iNr9_999LbOHkmOFSGucfXGifZvM3YGF9LvljaCQ-gxkdv7NMOBNZy6wq4-ckG8IurEwYfS_Nzl8pM-iw"
 +
    }
 +
</source>
 +
|}
 +
 
 +
[[Category:V:HTCC:9.0.0]]

Latest revision as of 18:54, June 30, 2020

Auth Namespace

Methods

The Auth namespace includes the following methods:

getJwtToken

To use the auth.getJwtToken endpoint, you must explicitly define the full endpoint name in the service-client-api.accepted-web-content-origins option. For example: service-client-api.accepted-web-content-origins = https://genesyspureengage.github.io (*, auth.getJwtToken)

Signature <static> getJwtToken(succeeded, failed) → {JSON object}
Description Get the JWT access token for the current session. If the token is already generated and still valid, it is returned; otherwise a new token is returned.
Parameters
Name Type Description
succeeded string The callback function to use if the operation succeeded.
failed string The callback function to use if the operation failed.
Returns JSON data object with the token and its expiration date in ISO 8601 date format. 
"data": {
        "expiration": "2020-04-14T13:26:51.846Z",
        "jwtToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImlzcyI6Imh0dHA6Ly9nd3MtY29yZS1hdXRoOjgwOTUvYXBpL2F1dGgvdjMvIiwia2lkIjoiZ3J2T1AwNmkyWkVMaEdTQWFUUnk1b2hhYjRh
bEVuK3lBbkVZQm5UdXNxYyJ9.eyJpc3MiOiJodHRwOi8vZ3dzLWNvcmUtYXV0aDo4MDk1L2FwaS9hdXRoL3YzLyIsInN1YiI6InVybjpnd3MtY29yZS1hdXRoOjk3MDM5ZjkwLTM5ZDgtNDhiOC04N2U0LTE0NmQyYWQ3ZDI5OTpTSVBfNTAwMjoxMDQiLCJ1cm46Z2VuZXN5c2Nsb3VkLmNvbS9hdXRoL3YzL2lzX3NlZl9pc3N1ZWQiOiJ0cnVlIiwiZXhwIjoxNTg2ODcwODcyLCJvcmciOiJ1cm46Z3dzLWNvcmUtYXV0aDo5NzAzOWY5MC0zOWQ4LTQ4YjgtODdlNC0xNDZkMmFkN2QyOTkiLCJ1cm46Z2VuZXN5c2Nsb3VkLmNvbS9hdXRoL3YzL3VzZXJfZGV0YWlscyI6eyJzdWIiOiJ1cm46Z2VuZXN5c2Nsb3VkLmNvbTo5NzAzOWY5MC0zOWQ4LTQ4YjgtODdlNC0xNDZkMmFkN2QyOTk6U0lQXzUwMDI6MTA0IiwiYXV0aG9yaXRpZXMiOltdLCJkYmlkIjoxMDQsInByb3BlcnRpZXMiOnsiZmlyc3ROYW1lIjoiNTAwMkYiLCJsYXN0TmFtZSI6IjUwMDJMIiwiYWNjZXNzR3JvdXBzIjoiMTAzIiwidGVuYW50REJJRCI6IjEifSwiZW52aXJvbm1lbnRfaWQiOiIzMDRiMTQ4OS02ZDVlLTRlMDUtOTVmMy1hYjQ1ZDE3OGExYzIiLCJjb250YWN0X2NlbnRlcl9pZCI6Ijk3MDM5ZjkwLTM5ZDgtNDhiOC04N2U0LTE0NmQyYWQ3ZDI5OSIsInVzZXJfbmFtZSI6IlNJUF81MDAyIiwiZ2l2ZW5fbmFtZSI6IjUwMDJGIiwiZmFtaWx5X25hbWUiOiI1MDAyTCIsImVtYWlsIjoiU0lQXzUwMDIifX0.dtBeVDvR13_yBIMFasBLzu9oX9R8PxogdBGZGeh05wX-89aZVr32-6TscaqWS6CrAh9l9TuaXrReJxVzcJ-2MNlUGNVLE7aTsECz0ISxsbgZtQxENbAwiwgYPA8iMJV124aISKVbDQGAgao8SSXP097lgWMnd1S1QTd3_DiibAf6QU9NVXbWACt7oU2s9TO_MH6gn2dZ0Kymcpxj2U6jLNlB3hcd04qasCpt_NAzYR4U3v1IXVYYCGKjOz0p9eXd0aR3iNr9_999LbOHkmOFSGucfXGifZvM3YGF9LvljaCQ-gxkdv7NMOBNZy6wq4-ckG8IurEwYfS_Nzl8pM-iw"
    }
This page was last edited on June 30, 2020, at 18:54.
Comments or questions about this documentation? Contact us for support!