oauth Section

This section must be called oauth, and is configured in the Genesys Administrator Extension Server Application object of type Genesys Administrator Server.

The options in this section are required for the OAuth module in Genesys Administrator Extension.

For the GWS login of GAX to work with HTTPS URL of GWS, you need to set the following parameters in the oauth section of the application option.

gws_auth_host

Default Value: Empty
Valid Values: Auth host URL; for example, https://gws-aps2.genhtcc.com.
Changes Take Effect: After Genesys Administrator Extension is restarted.
Specifies the Authorization Host URL.

Important

This option is mandatory from 9.0.100.72. GAX will not start if this option is not set.

gws_env_host

Default Value: Empty
Valid Values: Environment host URL; for example, http://gws-aps2-int.genhtcc.com.
Changes Take Effect: After Genesys Administrator Extension is restarted.
Specifies the Environment host URL.

Important

This option is mandatory from 9.0.100.72. GAX will not start if this option is not set.

Important

To make GAX GWS login work with GWS https URL, make sure you provide the GWS https URL in the gws_auth_host option and internal GWS URL in the gws_env_host parameter

access_token_uri

Default Value: Empty
Valid Values: A fully qualified URI for the OAuth service endpoint; for example, http://192.0.2.0:8095/auth/v3/oauth/token.
Changes Take Effect: After Genesys Administrator Extension is restarted.

Important

From GAX version 9.0.100.72, this parameter is included in the code and need not be set in the oauth section of the application option.

Specifies the Genesys Web Services (GWS) authentication server endpoint where the access token is granted.

client_id

Default Value: Empty
Valid Values: OAuth2 client ID; for example, dev_client.
Changes Take Effect: After Genesys Administrator Extension is restarted.

Specifies the client identifier issued during the registration of an application.

password

Default Value: Empty
Valid Values: OAuth 2 client secret; for example, gwstest.
Changes Take Effect: After Genesys Administrator Extension is restarted.

Specifies the confidential secret issued to the client during the registration of an application.

user_logout_uri

Default Value: Empty
Valid Values: URI for user logout; for example, http://192.0.2.0:8095/auth/v3/sign-out.
Changes Take Effect: After Genesys Administrator Extension is restarted.

Specifies the authentication server endpoint for logout.

Important

From GAX version 9.0.100.72, this parameter is included in the code and need not be set in the oauth section of the application option.

user_auth_uri

Default Value: Empty
Valid Values: URI for user authorization; for example, http://192.0.2.0:8095/auth/v3/oauth/authorize.
Changes Take Effect: After Genesys Administrator Extension is restarted.

Specifies the authentication server endpoint for user authorization.

Important

From GAX version 9.0.100.72, this parameter is included in the code and need not be set in the oauth section of the application option.

user_info_uri

Default Value: Empty
Valid Values: URI for user authorization; for example, http://192.0.2.0:8095/auth/v3/userinfo.
Changes Take Effect: After Genesys Administrator Extension is restarted.

Specifies the authentication server endpoint for retrieval of information about the current user from Genesys Web Services (GWS).

Important

From GAX version 9.0.100.72, this parameter is included in the code and need not be set in the oauth section of the application option.