PEC-Developer/Current/SCAPI/AuthNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

2023-02-22T13:44:15Z

Jumunn: Published

2022-02-18T13:20:39Z

Published

Julie.munn@genesys.com: Published

2021-03-25T17:52:39Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Auth Namespace
|Context=Learn about the Auth namespace methods and type definitions in the Service Client API.
|ComingSoon=No
|Role=Developer
|Section={{Section
|sectionHeading=Methods
|anchor=Methods
|alignment=Vertical
|structuredtext=The Auth namespace includes the following methods:

*{{Link-SomewhereInThisManual|topic=AuthNamespace|anchor=get|display text=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": "<your_jwt_token>"
}
</source>
{{!}}}
|Status=No
}}
}}

@@ Line 35: / Line 35: @@
 {{!}}-
 {{!}}succeeded
-{{!}}string
+{{!}}function
-{{!}}The callback function to use if the operation succeeded.
+{{!}}A function called when the operation succeeds.
 {{!}}-
 {{!}}failed
-{{!}}string
+{{!}}function
-{{!}}The callback function to use if the operation failed.
+{{!}}A function called when the operation fails.
 {{!}}}
 {{!}}-
@@ Line 47: / Line 47: @@
 <source lang="json">
 "data": {
-        "expiration": "2020-04-14T13:26:51.846Z",
+    "expiration": "2020-04-14T13:26:51.846Z",
-        "jwtToken": "<your_jwt_token>"
+    "jwtToken": "<your_jwt_token>"
-−
+}
 </source>
 {{!}}}

@@ Line 6: / Line 6: @@
 |Role=Developer
 |Section={{Section
 |sectionHeading=Methods
 |anchor=Methods
@@ Line 11: / Line 15: @@
 |structuredtext=The Auth namespace includes the following methods:
-*{{Link-SomewhereInThisManual|topic=AuthNamespace|anchor=get|display text=getJwtToken}}
+*{{Link-SomewhereInThisVersion|manual=SCAPI|topic=AuthNamespace|anchor=getJwtToken|display text=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>
+To use the <tt>auth.getJwtToken</tt> endpoint, you must explicitly define the full endpoint name in the [https://docs.genesys.com/Documentation/Options/Current/HTCC/GWS-interaction-workspace#service-client-api-accepted-web-content-origins service-client-api-accepted-web-content-origins] option. For example: <code>service-client-api.accepted-web-content-origins = https://genesyspureengage.github.io (*, auth.getJwtToken)</code>
 {{{!}}