GWS/Current/GWSPEGuide/Provision - Revision history

WikiSysop at 19:31, May 24, 2022

2022-05-24T19:31:06Z

WikiSysop at 12:16, May 4, 2022

2022-05-04T12:16:06Z

WikiSysop at 12:45, April 26, 2022

2022-04-26T12:45:56Z

Julie.munn@genesys.com: Published

2021-11-30T20:20:14Z

Published

Julie.munn@genesys.com: Published

2021-11-30T20:19:21Z

Published

Olena.chapovska@genesys.com: Published

2021-06-29T15:44:45Z

Published

Olena.chapovska@genesys.com: Published

2021-06-29T13:54:01Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Provision Genesys Web Services and Applications
|TocName=Provision GWS
|Context=Learn how to provision Genesys Web Services and Applications.
|ComingSoon=No
|Role=Administrator
|Section={{Section
|sectionHeading=Prerequisites
|anchor=Prerequisites
|alignment=Vertical
|structuredtext=*You have installed the Genesys Authentication services and the following URLs are accessible:
**<auth-url>/auth/v3/oauth/token
**<auth-url>/environment/v3/environments
*You have the ops credentials (admin_username and admin_password) from the '''values_gauth.yaml''' file.
*Genesys Web Services and Applications services are accessible.
*You have Configuration Server details such as hostname or IP, port, username, password, and cloud application name.
|Status=No
}}{{Section
|sectionHeading=Create API Client
|alignment=Vertical
|structuredtext=curl --location --request POST '<gauth-url>/auth/v3/ops/clients' \
--header 'Content-Type: application/json' \
--user ops:ops \ ---------------------------- Cloud ops credentials (<username:password>) from values_gauth.yaml. The default value is ops:ops
--data-raw '{"data": {
"name": "external_api_client", ----------------- <Client Name>
"clientType": "CONFIDENTIAL",
"refreshTokenExpirationTimeout": 43200,
"client_id": "external_api_client", ----------------- <Client ID>
"client_secret": "", --------------------------<Client Password>
"authorities": ["ROLE_INTERNAL_CLIENT"],
"scope": ["*"],
"authorizedGrantTypes": ["client_credentials", "authorization_code", "refresh_token", "password"],
"redirectURIs": ["<nowiki>https://gauth</nowiki>.<yourcluster.com>","<nowiki>https://wwe</nowiki>.<yourcluster.com>","<nowiki>https://gws</nowiki>.<yourcluster.com>","<nowiki>https://prov</nowiki>.<yourcluster.com>"], -----> should add gws/prov external URLS here
"accessTokenExpirationTimeout": 43200,
"contactCenterIds": [
"*" ------------------ <CCID or *>
]
}
}'
Result:
"status": {
"code": 0
},
"data": {
"clientType": "CONFIDENTIAL",
"scope": [
"*"
],
"internalClient": false,
"authorizedGrantTypes": [
"refresh_token",
"client_credentials",
"password",
"authorization_code",
"urn:ietf:params:oauth:grant-type:token-exchange",
"urn:ietf:params:oauth:grant-type:jwt-bearer"
],
"authorities": [
"ROLE_INTERNAL_CLIENT"
],
"redirectURIs": [
"<nowiki>https://gauth</nowiki>.<yourcluster.com>",
"<nowiki>https://gws</nowiki>.<yourcluster.com>",
"<nowiki>https://prov</nowiki>.<yourcluster.com>",
],
"contactCenterIds": [
"9350e2fc-a1dd-4c65-8d40-1f75a2e080dd"
],
"accessTokenExpirationTimeout": 43200,
"refreshTokenExpirationTimeout": 43200,
"createdAt": 1619796576236,
"name": "external_api_client",
"client_id": "external_api_client",
"client_secret": "secret",
"encrypted_client_secret": "A34BOmXDedZwbTKrwmd4eA=="
}
}
|Status=No
}}{{Section
|sectionHeading=Create Authentication Token
|alignment=Vertical
|structuredtext=curl --location --user external_api_client:secret --request POST '<gauth-url>/auth/v3/oauth/token' \ ----- user is the API client created in the previous step
--data-urlencode 'username=ops' \
--data-urlencode 'client_id=external_api_client' \ ------------------ client ID created in the previous step
--data-urlencode 'grant_type=password' \
--data-urlencode 'password=ops'

Result

{
"access_token": "5f1ecb33-5c63-4606-8e30-824e494194c6",
"token_type": "bearer",
"refresh_token": "f0c7eed6-cc55-426f-9594-7ae14903e749",
"expires_in": 43199,
"scope": "*"
}
|Status=No
}}{{Section
|sectionHeading=Add Genesys Tenant/Environment
|alignment=Vertical
|structuredtext={{NoteFormat|Complete this step after installing the Tenant service.|3}}
curl --location --request POST '<gauth-url>/environment/v3/environments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer f3aa2109-8889-4182-b2b7-d86917c53e4e' \ ----- access token generated in previous step
--data-raw '{
"data": {
"username": "default", ---------------------------- Configuration Server username
"password": "password", ------------------------- Configuration Server password
"connectionProtocol": "addp",
"remoteTimeout": 7,
"appName": "Cloud", -------------------------- Cloud app
"traceMode": "CFGTMBoth",
"tlsEnabled": false,
"configServers": [{
"primaryPort": 2020, ---------------------- Configuration Server port
"readOnly": false,
"primaryAddress": "172.24.132.84", ------ Configuration Server IP
"locations": "/USW1"
}],
"localTimeout": 5,
"tenant": "Environment"
}
}'

Result
{
"status": {
"code": 0
},
"path": "/environments/d0fb6386-236c-4739-aec0-b9c1bd6173df" - Environment ID
}
|Status=No
}}{{Section
|sectionHeading=Add Contact Center
|alignment=Vertical
|structuredtext={{NoteFormat|Complete this step after installing the Tenant service.|3}}
curl --location --request POST '<gauth-url>/environment/v3/contact-centers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 9901f8d6-0351-47f8-b718-7db992f53a02' \
--data-raw '{
"data": {
"domains": <customer-domain>,
"environmentId": "343dd264-7c26-4f9e-82c5-26baedbcb797", ------- > Environment ID created in the previous step
"auth": "configServer",
"id" : <CC-id> which is used while deploying tenant service
}
}'

Result
{
"status": {
"code": 0
},
"path": "/contact-centers/ed4c03f3-6275-4419-8b2b-11d14af10655" - Contact center ID

Record the contact center ID (also known as CCID) from the POST request above – you need it to provision other Genesys services. Now, open a web browser, navigate to the GWS URL and try to log in using any agent available in Configuration Server.
|Status=No
}}{{Section
|sectionHeading=Update CORS settings (optional)
|alignment=Vertical
|structuredtext=Make the following request only when services need CORS clearance from Genesys Web Services and Applications.
<source lang="text">curl --location --request POST '<gauth-url>/environment/v3/cors' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 201ad145-3b79-4d25-b88e-6c3279e00c63' \ --- Bearer Token
--data-raw '{
"data": {
"origin": "", ------------ URL to add Origin
"contactCenterId": "" -------------- CCID
}
}'</source>
|Status=No
}}
|PEPageType=55cef4ff-9306-4313-8fd8-377282a38478
}}

@@ Line 157: / Line 157: @@
 |alignment=Vertical
 |structuredtext=Please follow the {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|topic=Provision|anchor=UpdateCORS}} instructions for CORS settings.
 |Status=No
 }}
 |PEPageType=55cef4ff-9306-4313-8fd8-377282a38478
 }}

@@ Line 7: / Line 7: @@
 |Role=Administrator
 |Section={{Section
 |sectionHeading=Prerequisites
 |anchor=Prerequisites

@@ Line 7: / Line 7: @@
 |Role=Administrator
 |Section={{Section
 |sectionHeading=Prerequisites
 |anchor=Prerequisites
@@ Line 26: / Line 30: @@
    "name": "external_api_client", ----------------- <Client Name>
    "clientType": "CONFIDENTIAL",
    "refreshTokenExpirationTimeout": 43200,
    "client_id": "external_api_client", ----------------- <Client ID>
@@ Line 33: / Line 38: @@
    "authorizedGrantTypes": ["client_credentials", "authorization_code", "refresh_token", "password"],
    "redirectURIs": ["<nowiki>https://gauth</nowiki>.<yourcluster.com>","<nowiki>https://wwe</nowiki>.<yourcluster.com>","<nowiki>https://gws</nowiki>.<yourcluster.com>","<nowiki>https://prov</nowiki>.<yourcluster.com>"], -----> should add gws/prov external URLS here
-   "accessTokenExpirationTimeout": 43200,
+   "accessTokenExpirationTimeout": 43200
+   }
   }'
@@ Line 48: / Line 50: @@
       "*"
     ],
-    "internalClient": false,
+    "internalClient": true,
     "authorizedGrantTypes": [
     "refresh_token",
@@ Line 64: / Line 66: @@
       "<nowiki>https://gws</nowiki>.<yourcluster.com>",
       "<nowiki>https://prov</nowiki>.<yourcluster.com>",
     ],
     "accessTokenExpirationTimeout": 43200,
@@ Line 106: / Line 105: @@
   --data-raw '{
      "data": {
         "username": "default", ---------------------------- Configuration Server username
         "password": "password", ------------------------- Configuration Server password
@@ Line 144: / Line 144: @@
           "environmentId": "343dd264-7c26-4f9e-82c5-26baedbcb797", ------- > Environment ID created in the previous step
           "auth": "configServer",
-          "id" : <CC-id> which is used while deploying tenant service
+          "id" : <CC-id>, which is used while deploying Tenant service
+      }
   }'