AUTH/Current/AuthPEGuide/Provision - Revision history

WikiSysop at 16:15, September 29, 2022

2022-09-29T16:15:43Z

Show changes

Julie.munn@genesys.com at 20:21, November 30, 2021

2021-11-30T20:21:08Z

Julie.munn@genesys.com: Published

2021-11-30T20:20:51Z

Published

Julie.munn@genesys.com at 13:12, November 17, 2021

2021-11-17T13:12:47Z

Julie.munn@genesys.com at 13:11, November 17, 2021

2021-11-17T13:11:39Z

Ed.jamer@genesys.com: Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

2021-11-09T21:13:52Z

Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

Julie.munn@genesys.com: Published

2021-08-26T16:45:21Z

Published

Julie.munn@genesys.com: Published

2021-06-30T22:27:20Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Provision Genesys Authentication
|Context=Learn how to provision Genesys Authentication.
|ComingSoon=No
|Role=Administrator
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|Provisioning for Genesys Authentication is tied closely with other Genesys services. You must install these services before continuing with the steps on this page:

* {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|display text=Web Services and Applications}}
* {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service}}|3}}
|Status=No
}}{{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 ('''services.secret.admin_username''' and '''services.secret.admin_password''') from the '''values_gauth.yaml''' file.
*Web Services and Applications services are accessible.
*The Tenant Service is accessible.
*You have Configuration Server details such as hostname or IP, port, username, password, and cloud application name.
|Status=No
}}{{Section
|sectionHeading=Create a new API Client
|anchor=CreateAPI
|alignment=Vertical
|structuredtext=Make a POST request to create a new API client for Genesys Authentication:
<source lang="text">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": ["https://gauth.<yourcluster.com>","https://wwe.<yourcluster.com>","https://gws.<yourcluster.com>","https://prov.<yourcluster.com>"], -----> should add gws/prov external URLS here
"accessTokenExpirationTimeout": 43200,
"contactCenterIds": [
"*" ------------------ <CCID or *>
]

}
}'</source>
The result includes the '''client_id''' you need to {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Provision|anchor=CreateToken|display text=Create an authentication token}}:
<source lang="text">"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": [
"https://gauth.<yourcluster.com>",
"https://gws.<yourcluster.com>",
"https://prov.<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=="
}
}</source>
|Status=No
}}{{Section
|sectionHeading=Create an authentication token
|anchor=CreateToken
|alignment=Vertical
|structuredtext=Make the following POST request to create an authentication token:
<source lang="text">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'</source>
The result includes the '''access_token''' you need to {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Provision|anchor=AddTenant|display text=Add a Genesys tenant/environment}}:
<source lang="text">{
"access_token": "5f1ecb33-5c63-4606-8e30-824e494194c6",
"token_type": "bearer",
"refresh_token": "f0c7eed6-cc55-426f-9594-7ae14903e749",
"expires_in": 43199,
"scope": "*"
}</source>
|Status=No
}}{{Section
|sectionHeading=Add a Genesys tenant/environment
|anchor=AddTenant
|alignment=Vertical
|structuredtext={{NoteFormat|Complete this step after installing the Tenant service.|3}}
Make the following POST request to create the Environment tenant:
<source lang="text">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"
}
}'</source>
The result includes the environment ID you need to {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Provision|anchor=AddCC|display text=Add a contact center}}:
<source text="lang">{
"status": {
"code": 0
},
"path": "/environments/d0fb6386-236c-4739-aec0-b9c1bd6173df" - Environment ID
}</source>
|Status=No
}}{{Section
|sectionHeading=Add a contact center
|anchor=AddCC
|alignment=Vertical
|structuredtext={{NoteFormat|Complete this step after installing the Tenant service.|3}}
Make the following POST request to add a contact center to the environment:
<source lang="text">
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
}
}'</source>
The result includes the contact center ID (also known as CCID) you will need to provision other Genesys services:
<source lang="text">{
"status": {
"code": 0
},
"path": "/contact-centers/ed4c03f3-6275-4419-8b2b-11d14af10655" - Contact center ID
}</source>
|Status=No
}}{{Section
|sectionHeading=Add a data center
|anchor=data
|alignment=Vertical
|structuredtext=Make the following POST request to add a data center:

<source lang="text">
curl --location --request POST '<gauth-url>/environment/v3/data-centers' \
--user ops:ops \
--header 'Content-Type: application/json' \
--data '{
"data": {
"location": "/usw1", <----- region as per Genesys Engage name convention
"entryPoint": <gauth-url>, <----- for location above
"readOnly": false/true <----- should be true for a primary or writeable region only, false for all other regions
}
}'
</source>

The result should look like this:
<source lang="text">
"status": {
"code": 0
}
</source>
|Status=No
}}{{Section
|sectionHeading=Update CORS settings (optional)
|anchor=UpdateCORS
|alignment=Vertical
|structuredtext=Make the following request only when services need CORS clearance from 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 27: / Line 27: @@
 |alignment=Vertical
 |structuredtext=Make a POST request to create a new API client for Genesys Authentication:
 <source lang="text">curl --location --request POST '<gauth-url>/auth/v3/ops/clients' \
 --header 'Content-Type: application/json' \

@@ Line 18: / Line 18: @@
 **<auth-url>/auth/v3/oauth/token
 **<auth-url>/environment/v3/environments
-*You have the ops credentials ('''services.secret.admin_username''' and '''services.secret.admin_password''') from the '''values_gauth.yaml''' file.
+*You have the ops credentials ('''services.secret.admin_username''' and '''services.secret.admin_password''') from the '''values.yaml''' file.
 *The Tenant Service is accessible.
 *You have Configuration Server details such as hostname or IP, port, username, password, and cloud application name.
@@ Line 27: / Line 27: @@
 |alignment=Vertical
 |structuredtext=Make a POST request to create a new API client for Genesys Authentication:
 <source lang="text">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
+--user ops:ops \ ---------------------------- Cloud ops credentials (<username:password>) from values.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>
@@ Line 40: / Line 43: @@
      "authorizedGrantTypes": ["client_credentials", "authorization_code", "refresh_token", "password"],
      "redirectURIs": ["https://gauth.<yourcluster.com>","https://wwe.<yourcluster.com>","https://gws.<yourcluster.com>","https://prov.<yourcluster.com>"], -----> should add gws/prov external URLS here
-     "accessTokenExpirationTimeout": 43200,
+     "accessTokenExpirationTimeout": 43200
+     }
 }'</source>
@@ Line 56: / Line 55: @@
              "*"
          ],
-         "internalClient": false,
+         "internalClient": true,
          "authorizedGrantTypes": [
              "refresh_token",
@@ Line 74: / Line 73: @@
              "https://prov.<yourcluster.com>",
          ],
          "accessTokenExpirationTimeout": 43200,
@@ Line 119: / Line 115: @@
 --data-raw '{
      "data": {
          "username": "default", ---------------------------- Configuration Server username
          "password": "password", ------------------------- Configuration Server password
@@ Line 161: / Line 158: @@
          "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 the Tenant service
+     }
 }'</source>

@@ Line 9: / Line 9: @@
 |structuredtext={{NoteFormat|Provisioning for Genesys Authentication is tied closely with other Genesys services. You must install these services before continuing with the steps on this page:
 * {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service}}|3}}
 |Status=No

@@ Line 186: / Line 186: @@
 --data '{
      "data": {
-         "location": "/usw1", <----- region as per Genesys Engage name convention
+         "location": "/usw1", <----- region as per Genesys Multicloud CX name convention
          "entryPoint": <gauth-url>, <----- for location above
          "readOnly": false/true <----- should be true for a primary or writeable region only, false for all other regions

@@ Line 204: / Line 204: @@
 |anchor=UpdateCORS
 |alignment=Vertical
-|structuredtext=Make the following request only when services need CORS clearance from Web Services and Applications.
+|structuredtext=Make the following request only when services need CORS clearance from Web Services and Applications. Updates to the '''value''' field, which contains the list of URLs that require CORS permission, override any existing records. To preserve the existing records, make a GET request to collect the URLs and then append the new values as a comma separate list in your POST. <syntaxhighlight lang="json">
-<source lang="text">curl --location --request POST '<gauth-url>/environment/v3/cors' \
+curl --location --request POST '<gauth-url>/environment/v3/contact-centers/<contactcenter-id>/settings' \
 --header 'Content-Type: application/json' \
---header 'Authorization: Bearer 201ad145-3b79-4d25-b88e-6c3279e00c63' \ --- Bearer Token
+--header 'Authorization: Bearer 3f26790a-6e5b-4dc7-a139-ae78dab2a331' \ -- Bearer token
---data-raw '{
+--data-raw '
-    "data": {
-        "origin": "", ------------ URL to add Origin
+   "data":{
-        "contactCenterId": "" -------------- CCID
+      "location":"/",
+      "name":"cors-origins",
-}'</source>
+      "shared":"true",
 |Status=No
 }}
 |PEPageType=55cef4ff-9306-4313-8fd8-377282a38478
 }}