instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
Provide a Python example that uses the POST /api/v2/gamification/profiles/{profileId}/members Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Assign members to a given performance profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | Profile Id
body = PureCloudPlatformClientV2.AssignUsers() # AssignUsers | assignUsers
try:
# Assign members to a given performance profile
api_response = api_instance.post_gamification_profile_members(profile_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->post_gamification_profile_members: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/gamification/profiles/{profileId}/members/validate Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Validate member assignment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | Profile Id
body = PureCloudPlatformClientV2.ValidateAssignUsers() # ValidateAssignUsers | memberAssignments
try:
# Validate member assignment
api_response = api_instance.post_gamification_profile_members_validate(profile_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->post_gamification_profile_members_validate: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/profiles/{profileId}/metrics Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: All gamified metrics for a given performance profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | Performance Profile Id
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
workday = '2013-10-20' # date | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
metric_ids = 'metric_ids_example' # str | List of metric ids to filter the response (Optional, comma-separated). (optional)
try:
# All gamified metrics for a given performance profile
api_response = api_instance.get_gamification_profile_metrics(profile_id, expand=expand, workday=workday, metric_ids=metric_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_profile_metrics: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/gamification/profiles/{profileId}/metrics Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Creates a gamified metric with a given metric definition and metric objective under in a performance profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | Performance Profile Id
body = PureCloudPlatformClientV2.CreateMetric() # CreateMetric | Metric
try:
# Creates a gamified metric with a given metric definition and metric objective under in a performance profile
api_response = api_instance.post_gamification_profile_metrics(profile_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->post_gamification_profile_metrics: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/profiles/{profileId}/metrics/objectivedetails Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: All metrics for a given performance profile with objective details such as order and maxPoints
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | Performance Profile Id
workday = '2013-10-20' # date | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
try:
# All metrics for a given performance profile with objective details such as order and maxPoints
api_response = api_instance.get_gamification_profile_metrics_objectivedetails(profile_id, workday=workday)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_profile_metrics_objectivedetails: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/profiles/{profileId}/metrics/{metricId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Performance profile gamified metric by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | Performance Profile Id
metric_id = 'metric_id_example' # str | Metric Id
workday = '2013-10-20' # date | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
try:
# Performance profile gamified metric by id
api_response = api_instance.get_gamification_profile_metric(profile_id, metric_id, workday=workday)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_profile_metric: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/gamification/profiles/{profileId}/metrics/{metricId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Updates a metric in performance profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | Performance Profile Id
metric_id = 'metric_id_example' # str | Metric Id
body = PureCloudPlatformClientV2.CreateMetric() # CreateMetric | Metric
try:
# Updates a metric in performance profile
api_response = api_instance.put_gamification_profile_metric(profile_id, metric_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->put_gamification_profile_metric: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Creates a linked metric
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
source_profile_id = 'source_profile_id_example' # str | Source Performance Profile Id
source_metric_id = 'source_metric_id_example' # str | Source Metric Id
body = PureCloudPlatformClientV2.TargetPerformanceProfile() # TargetPerformanceProfile | linkedMetric
try:
# Creates a linked metric
api_response = api_instance.post_gamification_profile_metric_link(source_profile_id, source_metric_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->post_gamification_profile_metric_link: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Workday performance metrics of the requesting user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
workday = '2013-10-20' # date | Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Workday performance metrics of the requesting user
api_response = api_instance.get_gamification_scorecards(workday, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/attendance Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Attendance status metrics of the requesting user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
try:
# Attendance status metrics of the requesting user
api_response = api_instance.get_gamification_scorecards_attendance(start_workday, end_workday)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_attendance: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/bestpoints Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Best points of the requesting user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
try:
# Best points of the requesting user
api_response = api_instance.get_gamification_scorecards_bestpoints()
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_bestpoints: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/points/alltime Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: All-time points of the requesting user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
try:
# All-time points of the requesting user
api_response = api_instance.get_gamification_scorecards_points_alltime(end_workday)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_points_alltime: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/points/average Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Average points of the requesting user's division or performance profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
workday = '2013-10-20' # date | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
try:
# Average points of the requesting user's division or performance profile
api_response = api_instance.get_gamification_scorecards_points_average(workday)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_points_average: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/points/trends Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Points trends of the requesting user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
day_of_week = 'day_of_week_example' # str | Optional filter to specify which day of weeks to be included in the response (optional)
try:
# Points trends of the requesting user
api_response = api_instance.get_gamification_scorecards_points_trends(start_workday, end_workday, day_of_week=day_of_week)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_points_trends: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Average performance values trends by metric of a division or a performance profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | performanceProfileId
metric_id = 'metric_id_example' # str | metricId
filter_type = 'filter_type_example' # str | Filter type for the query request.
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
filter_id = 'filter_id_example' # str | ID for the filter type. Only required when filterType is Division. (optional)
reference_workday = '2013-10-20' # date | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC')
try:
# Average performance values trends by metric of a division or a performance profile
api_response = api_instance.get_gamification_scorecards_profile_metric_users_values_trends(profile_id, metric_id, filter_type, start_workday, end_workday, filter_id=filter_id, reference_workday=reference_workday, time_zone=time_zone)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_profile_metric_users_values_trends: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Average performance values trends by metric of a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | performanceProfileId
metric_id = 'metric_id_example' # str | metricId
user_id = 'user_id_example' # str |
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
reference_workday = '2013-10-20' # date | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC')
try:
# Average performance values trends by metric of a user
api_response = api_instance.get_gamification_scorecards_profile_metric_user_values_trends(profile_id, metric_id, user_id, start_workday, end_workday, reference_workday=reference_workday, time_zone=time_zone)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_profile_metric_user_values_trends: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Average performance values trends by metric of the requesting user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
profile_id = 'profile_id_example' # str | performanceProfileId
metric_id = 'metric_id_example' # str | metricId
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
filter_type = 'filter_type_example' # str | Filter type for the query request. If not set, returns the values trends of the requesting user (optional)
reference_workday = '2013-10-20' # date | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC')
try:
# Average performance values trends by metric of the requesting user
api_response = api_instance.get_gamification_scorecards_profile_metric_values_trends(profile_id, metric_id, start_workday, end_workday, filter_type=filter_type, reference_workday=reference_workday, time_zone=time_zone)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_profile_metric_values_trends: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/points/average Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Workday average points by target group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
filter_type = 'filter_type_example' # str | Filter type for the query request.
filter_id = 'filter_id_example' # str | ID for the filter type.
workday = '2013-10-20' # date | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
try:
# Workday average points by target group
api_response = api_instance.get_gamification_scorecards_users_points_average(filter_type, filter_id, workday)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_users_points_average: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/values/average Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Workday average values by target group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
filter_type = 'filter_type_example' # str | Filter type for the query request.
filter_id = 'filter_id_example' # str | ID for the filter type. For example, division Id
workday = '2013-10-20' # date | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC')
try:
# Workday average values by target group
api_response = api_instance.get_gamification_scorecards_users_values_average(filter_type, filter_id, workday, time_zone=time_zone)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_users_values_average: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/values/trends Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Values trend by target group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
filter_type = 'filter_type_example' # str | Filter type for the query request.
filter_id = 'filter_id_example' # str | ID for the filter type.
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC')
try:
# Values trend by target group
api_response = api_instance.get_gamification_scorecards_users_values_trends(filter_type, filter_id, start_workday, end_workday, time_zone=time_zone)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_users_values_trends: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Workday performance metrics for a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
user_id = 'user_id_example' # str |
workday = '2013-10-20' # date | Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Workday performance metrics for a user
api_response = api_instance.get_gamification_scorecards_user(user_id, workday, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_user: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/attendance Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Attendance status metrics for a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
user_id = 'user_id_example' # str |
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
try:
# Attendance status metrics for a user
api_response = api_instance.get_gamification_scorecards_user_attendance(user_id, start_workday, end_workday)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_user_attendance: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/bestpoints Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Best points of a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
user_id = 'user_id_example' # str |
try:
# Best points of a user
api_response = api_instance.get_gamification_scorecards_user_bestpoints(user_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_user_bestpoints: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/points/alltime Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: All-time points for a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
user_id = 'user_id_example' # str |
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
try:
# All-time points for a user
api_response = api_instance.get_gamification_scorecards_user_points_alltime(user_id, end_workday)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_user_points_alltime: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/points/trends Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Points trend for a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
user_id = 'user_id_example' # str |
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
day_of_week = 'day_of_week_example' # str | Optional filter to specify which day of weeks to be included in the response (optional)
try:
# Points trend for a user
api_response = api_instance.get_gamification_scorecards_user_points_trends(user_id, start_workday, end_workday, day_of_week=day_of_week)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_user_points_trends: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/values/trends Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Values trends of a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
user_id = 'user_id_example' # str |
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC')
try:
# Values trends of a user
api_response = api_instance.get_gamification_scorecards_user_values_trends(user_id, start_workday, end_workday, time_zone=time_zone)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_user_values_trends: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/values/average Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Average values of the requesting user's division or performance profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
workday = '2013-10-20' # date | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC')
try:
# Average values of the requesting user's division or performance profile
api_response = api_instance.get_gamification_scorecards_values_average(workday, time_zone=time_zone)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_values_average: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/scorecards/values/trends Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Values trends of the requesting user or group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
filter_type = 'filter_type_example' # str | Filter type for the query request. If not set, then the request is for the requesting user. (optional)
reference_workday = '2013-10-20' # date | Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)
time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC')
try:
# Values trends of the requesting user or group
api_response = api_instance.get_gamification_scorecards_values_trends(start_workday, end_workday, filter_type=filter_type, reference_workday=reference_workday, time_zone=time_zone)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_scorecards_values_trends: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/status Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Gamification activation status
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
try:
# Gamification activation status
api_response = api_instance.get_gamification_status()
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_status: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/gamification/status Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update gamification activation status
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
status = PureCloudPlatformClientV2.GamificationStatus() # GamificationStatus | Gamification status
try:
# Update gamification activation status
api_response = api_instance.put_gamification_status(status)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->put_gamification_status: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/templates Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: All objective templates
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
try:
# All objective templates
api_response = api_instance.get_gamification_templates()
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_templates: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gamification/templates/{templateId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Objective template by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GamificationApi();
template_id = 'template_id_example' # str | template id
try:
# Objective template by id
api_response = api_instance.get_gamification_template(template_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GamificationApi->get_gamification_template: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gdpr/requests Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get all GDPR requests
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GeneralDataProtectionRegulationApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
try:
# Get all GDPR requests
api_response = api_instance.get_gdpr_requests(page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_requests: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/gdpr/requests Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Submit a new GDPR request
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GeneralDataProtectionRegulationApi();
body = PureCloudPlatformClientV2.GDPRRequest() # GDPRRequest | GDPR request
delete_confirmed = False # bool | Confirm delete (optional) (default to False)
try:
# Submit a new GDPR request
api_response = api_instance.post_gdpr_requests(body, delete_confirmed=delete_confirmed)
pprint(api_response)
except ApiException as e:
print("Exception when calling GeneralDataProtectionRegulationApi->post_gdpr_requests: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gdpr/requests/{requestId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get an existing GDPR request
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GeneralDataProtectionRegulationApi();
request_id = 'request_id_example' # str | Request id
try:
# Get an existing GDPR request
api_response = api_instance.get_gdpr_request(request_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_request: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/gdpr/subjects Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get GDPR subjects
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GeneralDataProtectionRegulationApi();
search_type = 'search_type_example' # str | Search Type
search_value = 'search_value_example' # str | Search Value
try:
# Get GDPR subjects
api_response = api_instance.get_gdpr_subjects(search_type, search_value)
pprint(api_response)
except ApiException as e:
print("Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_subjects: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/geolocations/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a organization's GeolocationSettings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GeolocationApi();
try:
# Get a organization's GeolocationSettings
api_response = api_instance.get_geolocations_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling GeolocationApi->get_geolocations_settings: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/geolocations/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Patch a organization's GeolocationSettings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GeolocationApi();
body = PureCloudPlatformClientV2.GeolocationSettings() # GeolocationSettings | Geolocation settings
try:
# Patch a organization's GeolocationSettings
api_response = api_instance.patch_geolocations_settings(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GeolocationApi->patch_geolocations_settings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/users/{userId}/geolocations/{clientId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a user's Geolocation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
user_id = 'user_id_example' # str | user Id
client_id = 'client_id_example' # str | client Id
try:
# Get a user's Geolocation
api_response = api_instance.get_user_geolocation(user_id, client_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_user_geolocation: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/users/{userId}/geolocations/{clientId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Patch a user's Geolocation. The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
user_id = 'user_id_example' # str | user Id
client_id = 'client_id_example' # str | client Id
body = PureCloudPlatformClientV2.Geolocation() # Geolocation | Geolocation
try:
# Patch a user's Geolocation
api_response = api_instance.patch_user_geolocation(user_id, client_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->patch_user_geolocation: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/greetings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Gets an Organization's Greetings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
try:
# Gets an Organization's Greetings
api_response = api_instance.get_greetings(page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->get_greetings: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/greetings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a Greeting for an Organization
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
body = PureCloudPlatformClientV2.Greeting() # Greeting | The Greeting to create
try:
# Create a Greeting for an Organization
api_response = api_instance.post_greetings(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->post_greetings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/greetings/defaults Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get an Organization's DefaultGreetingList
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
try:
# Get an Organization's DefaultGreetingList
api_response = api_instance.get_greetings_defaults()
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->get_greetings_defaults: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/greetings/defaults Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update an Organization's DefaultGreetingList
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
body = PureCloudPlatformClientV2.DefaultGreetingList() # DefaultGreetingList | The updated defaultGreetingList
try:
# Update an Organization's DefaultGreetingList
api_response = api_instance.put_greetings_defaults(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->put_greetings_defaults: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/greetings/{greetingId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Deletes a Greeting with the given GreetingId
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
greeting_id = 'greeting_id_example' # str | Greeting ID
try:
# Deletes a Greeting with the given GreetingId
api_instance.delete_greeting(greeting_id)
except ApiException as e:
print("Exception when calling GreetingsApi->delete_greeting: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/greetings/{greetingId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Greeting with the given GreetingId
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
greeting_id = 'greeting_id_example' # str | Greeting ID
try:
# Get a Greeting with the given GreetingId
api_response = api_instance.get_greeting(greeting_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->get_greeting: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/greetings/{greetingId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Updates the Greeting with the given GreetingId
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
greeting_id = 'greeting_id_example' # str | Greeting ID
body = PureCloudPlatformClientV2.Greeting() # Greeting | The updated Greeting
try:
# Updates the Greeting with the given GreetingId
api_response = api_instance.put_greeting(greeting_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->put_greeting: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/greetings/{greetingId}/media Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get media playback URI for this greeting
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
greeting_id = 'greeting_id_example' # str | Greeting ID
format_id = ''WAV'' # str | The desired media format. (optional) (default to 'WAV')
try:
# Get media playback URI for this greeting
api_response = api_instance.get_greeting_media(greeting_id, format_id=format_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->get_greeting_media: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/groups/{groupId}/greetings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of the Group's Greetings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
group_id = 'group_id_example' # str | Group ID
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
try:
# Get a list of the Group's Greetings
api_response = api_instance.get_group_greetings(group_id, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->get_group_greetings: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/groups/{groupId}/greetings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Creates a Greeting for a Group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
group_id = 'group_id_example' # str | Group ID
body = PureCloudPlatformClientV2.Greeting() # Greeting | The Greeting to create
try:
# Creates a Greeting for a Group
api_response = api_instance.post_group_greetings(group_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->post_group_greetings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/groups/{groupId}/greetings/defaults Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Grabs the list of Default Greetings given a Group's ID
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
group_id = 'group_id_example' # str | Group ID
try:
# Grabs the list of Default Greetings given a Group's ID
api_response = api_instance.get_group_greetings_defaults(group_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->get_group_greetings_defaults: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/groups/{groupId}/greetings/defaults Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Updates the DefaultGreetingList of the specified Group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
group_id = 'group_id_example' # str | Group ID
body = PureCloudPlatformClientV2.DefaultGreetingList() # DefaultGreetingList | The updated defaultGreetingList
try:
# Updates the DefaultGreetingList of the specified Group
api_response = api_instance.put_group_greetings_defaults(group_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->put_group_greetings_defaults: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/users/{userId}/greetings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of the User's Greetings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
user_id = 'user_id_example' # str | User ID
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
try:
# Get a list of the User's Greetings
api_response = api_instance.get_user_greetings(user_id, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->get_user_greetings: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/users/{userId}/greetings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Creates a Greeting for a User
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
user_id = 'user_id_example' # str | User ID
body = PureCloudPlatformClientV2.Greeting() # Greeting | The Greeting to create
try:
# Creates a Greeting for a User
api_response = api_instance.post_user_greetings(user_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->post_user_greetings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/users/{userId}/greetings/defaults Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Grabs the list of Default Greetings given a User's ID
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
user_id = 'user_id_example' # str | User ID
try:
# Grabs the list of Default Greetings given a User's ID
api_response = api_instance.get_user_greetings_defaults(user_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->get_user_greetings_defaults: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/users/{userId}/greetings/defaults Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Updates the DefaultGreetingList of the specified User
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GreetingsApi();
user_id = 'user_id_example' # str | User ID
body = PureCloudPlatformClientV2.DefaultGreetingList() # DefaultGreetingList | The updated defaultGreetingList
try:
# Updates the DefaultGreetingList of the specified User
api_response = api_instance.put_user_greetings_defaults(user_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GreetingsApi->put_user_greetings_defaults: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/groups Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a group list
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
id = ['id_example'] # list[str] | id (optional)
jabber_id = ['jabber_id_example'] # list[str] | A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter) (optional)
sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC')
try:
# Get a group list
api_response = api_instance.get_groups(page_size=page_size, page_number=page_number, id=id, jabber_id=jabber_id, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupsApi->get_groups: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/groups Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
body = PureCloudPlatformClientV2.GroupCreate() # GroupCreate | Group
try:
# Create a group
api_response = api_instance.post_groups(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupsApi->post_groups: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/groups/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search groups using the q64 value returned from a previous search
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SearchApi();
q64 = 'q64_example' # str | q64
expand = ['expand_example'] # list[str] | expand (optional)
try:
# Search groups using the q64 value returned from a previous search
api_response = api_instance.get_groups_search(q64, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->get_groups_search: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/groups/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search groups
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SearchApi();
body = PureCloudPlatformClientV2.GroupSearchRequest() # GroupSearchRequest | Search request options
try:
# Search groups
api_response = api_instance.post_groups_search(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->post_groups_search: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/groups/{groupId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
group_id = 'group_id_example' # str | Group ID
try:
# Delete group
api_instance.delete_group(group_id)
except ApiException as e:
print("Exception when calling GroupsApi->delete_group: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/groups/{groupId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
group_id = 'group_id_example' # str | Group ID
try:
# Get group
api_response = api_instance.get_group(group_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupsApi->get_group: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/groups/{groupId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
group_id = 'group_id_example' # str | Group ID
body = PureCloudPlatformClientV2.GroupUpdate() # GroupUpdate | Group (optional)
try:
# Update group
api_response = api_instance.put_group(group_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupsApi->put_group: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/groups/{groupId}/individuals Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get all individuals associated with the group
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
group_id = 'group_id_example' # str | Group ID
try:
# Get all individuals associated with the group
api_response = api_instance.get_group_individuals(group_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupsApi->get_group_individuals: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/groups/{groupId}/members Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Remove members
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
group_id = 'group_id_example' # str | Group ID
ids = 'ids_example' # str | Comma separated list of userIds to remove
try:
# Remove members
api_response = api_instance.delete_group_members(group_id, ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupsApi->delete_group_members: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/groups/{groupId}/members Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get group members, includes individuals, owners, and dynamically included people
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
group_id = 'group_id_example' # str | Group ID
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC')
expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional)
try:
# Get group members, includes individuals, owners, and dynamically included people
api_response = api_instance.get_group_members(group_id, page_size=page_size, page_number=page_number, sort_order=sort_order, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupsApi->get_group_members: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/groups/{groupId}/members Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add members
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.GroupsApi();
group_id = 'group_id_example' # str | Group ID
body = PureCloudPlatformClientV2.GroupMembersUpdate() # GroupMembersUpdate | Add members
try:
# Add members
api_response = api_instance.post_group_members(group_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling GroupsApi->post_group_members: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: The list of identity providers
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# The list of identity providers
api_response = api_instance.get_identityproviders()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/identityproviders Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.CustomProvider() # CustomProvider | Provider
try:
# Create Identity Provider
api_response = api_instance.post_identityproviders(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->post_identityproviders: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/adfs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete ADFS Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete ADFS Identity Provider
api_response = api_instance.delete_identityproviders_adfs()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_adfs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/adfs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get ADFS Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get ADFS Identity Provider
api_response = api_instance.get_identityproviders_adfs()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_adfs: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/adfs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create ADFS Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.ADFS() # ADFS | Provider
try:
# Update/Create ADFS Identity Provider
api_response = api_instance.put_identityproviders_adfs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_adfs: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/cic Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Customer Interaction Center (CIC) Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete Customer Interaction Center (CIC) Identity Provider
api_response = api_instance.delete_identityproviders_cic()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_cic: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/cic Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Customer Interaction Center (CIC) Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get Customer Interaction Center (CIC) Identity Provider
api_response = api_instance.get_identityproviders_cic()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_cic: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/cic Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create Customer Interaction Center (CIC) Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.CustomerInteractionCenter() # CustomerInteractionCenter | Provider
try:
# Update/Create Customer Interaction Center (CIC) Identity Provider
api_response = api_instance.put_identityproviders_cic(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_cic: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/generic Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Generic SAML Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete Generic SAML Identity Provider
api_response = api_instance.delete_identityproviders_generic()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_generic: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/generic Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Generic SAML Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get Generic SAML Identity Provider
api_response = api_instance.get_identityproviders_generic()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_generic: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/generic Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create Generic SAML Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.GenericSAML() # GenericSAML | Provider
try:
# Update/Create Generic SAML Identity Provider
api_response = api_instance.put_identityproviders_generic(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_generic: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/gsuite Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete G Suite Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete G Suite Identity Provider
api_response = api_instance.delete_identityproviders_gsuite()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_gsuite: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/gsuite Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get G Suite Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get G Suite Identity Provider
api_response = api_instance.get_identityproviders_gsuite()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_gsuite: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/gsuite Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create G Suite Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.GSuite() # GSuite | Provider
try:
# Update/Create G Suite Identity Provider
api_response = api_instance.put_identityproviders_gsuite(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_gsuite: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/identitynow Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete IdentityNow Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete IdentityNow Provider
api_response = api_instance.delete_identityproviders_identitynow()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_identitynow: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/identitynow Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get IdentityNow Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get IdentityNow Provider
api_response = api_instance.get_identityproviders_identitynow()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_identitynow: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/identitynow Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create IdentityNow Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.IdentityNow() # IdentityNow | Provider
try:
# Update/Create IdentityNow Provider
api_response = api_instance.put_identityproviders_identitynow(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_identitynow: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/okta Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Okta Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete Okta Identity Provider
api_response = api_instance.delete_identityproviders_okta()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_okta: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/okta Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Okta Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get Okta Identity Provider
api_response = api_instance.get_identityproviders_okta()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_okta: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/okta Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create Okta Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.Okta() # Okta | Provider
try:
# Update/Create Okta Identity Provider
api_response = api_instance.put_identityproviders_okta(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_okta: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/onelogin Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete OneLogin Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete OneLogin Identity Provider
api_response = api_instance.delete_identityproviders_onelogin()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_onelogin: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/onelogin Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get OneLogin Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get OneLogin Identity Provider
api_response = api_instance.get_identityproviders_onelogin()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_onelogin: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/onelogin Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create OneLogin Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.OneLogin() # OneLogin | Provider
try:
# Update/Create OneLogin Identity Provider
api_response = api_instance.put_identityproviders_onelogin(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_onelogin: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/ping Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Ping Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete Ping Identity Provider
api_response = api_instance.delete_identityproviders_ping()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_ping: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/ping Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Ping Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get Ping Identity Provider
api_response = api_instance.get_identityproviders_ping()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_ping: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/ping Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create Ping Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.PingIdentity() # PingIdentity | Provider
try:
# Update/Create Ping Identity Provider
api_response = api_instance.put_identityproviders_ping(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_ping: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/purecloud Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete PureCloud Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete PureCloud Identity Provider
api_response = api_instance.delete_identityproviders_purecloud()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_purecloud: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/purecloud Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get PureCloud Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get PureCloud Identity Provider
api_response = api_instance.get_identityproviders_purecloud()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_purecloud: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/purecloud Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create PureCloud Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.PureCloud() # PureCloud | Provider
try:
# Update/Create PureCloud Identity Provider
api_response = api_instance.put_identityproviders_purecloud(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_purecloud: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/pureengage Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete PureEngage Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete PureEngage Identity Provider
api_response = api_instance.delete_identityproviders_pureengage()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_pureengage: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/pureengage Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get PureEngage Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Get PureEngage Identity Provider
api_response = api_instance.get_identityproviders_pureengage()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_pureengage: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/pureengage Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create PureEngage Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
body = PureCloudPlatformClientV2.PureEngage() # PureEngage | Provider
try:
# Update/Create PureEngage Identity Provider
api_response = api_instance.put_identityproviders_pureengage(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_pureengage: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/salesforce Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Salesforce Identity Provider
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.IdentityProviderApi();
try:
# Delete Salesforce Identity Provider
api_response = api_instance.delete_identityproviders_salesforce()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityproviders_salesforce: %s\n" % e)```
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.