purecloudplatformclientv2 92.0.0 → 93.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/AnalyticsSession.md +4 -0
- data/docs/ArchitectApi.md +51 -49
- data/docs/CoachingApi.md +8 -7
- data/docs/CommonCampaign.md +17 -0
- data/docs/CommonCampaignDivisionView.md +17 -0
- data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
- data/docs/CommonCampaignEntityListing.md +22 -0
- data/docs/ConversationAssociation.md +1 -1
- data/docs/ConversationEventTopicMessage.md +1 -0
- data/docs/ConversationsApi.md +4 -4
- data/docs/ExternalContactsApi.md +4 -4
- data/docs/HistoricalAdherenceActuals.md +15 -0
- data/docs/HistoricalAdherenceDayMetrics.md +23 -0
- data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
- data/docs/HistoricalAdherenceQueryResult.md +21 -0
- data/docs/KnowledgeSearchRequest.md +3 -3
- data/docs/MessagingCampaign.md +28 -0
- data/docs/MessagingCampaignDivisionView.md +16 -0
- data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
- data/docs/MessagingCampaignEntityListing.md +22 -0
- data/docs/ObservationValue.md +3 -1
- data/docs/OutboundApi.md +881 -76
- data/docs/QueueConversationEventTopicMessage.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
- data/docs/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +3 -0
- data/docs/SCIMApi.md +96 -108
- data/docs/ScimConfigResourceType.md +1 -1
- data/docs/ScimUserExtensions.md +2 -2
- data/docs/ScimUserRole.md +1 -1
- data/docs/ScimUserRoutingLanguage.md +2 -2
- data/docs/ScimUserRoutingSkill.md +2 -2
- data/docs/ScimV2CreateUser.md +3 -3
- data/docs/ScimV2Group.md +1 -1
- data/docs/ScimV2SchemaAttribute.md +11 -11
- data/docs/ScimV2SchemaDefinition.md +4 -4
- data/docs/ScimV2SchemaListResponse.md +1 -1
- data/docs/ScimV2User.md +4 -4
- data/docs/SmsConfig.md +15 -0
- data/docs/SmsPhoneNumberRef.md +14 -0
- data/docs/UserRoutingLanguage.md +3 -3
- data/docs/UserRoutingLanguagePost.md +1 -1
- data/docs/UserRoutingSkill.md +1 -1
- data/docs/VoicemailUserPolicy.md +1 -0
- data/docs/WfmBusinessUnitReference.md +14 -0
- data/docs/WfmHistoricalAdherenceResponse.md +1 -0
- data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
- data/docs/WfmScheduleReference.md +16 -0
- data/lib/purecloudplatformclientv2.rb +19 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +10 -9
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
- data/lib/purecloudplatformclientv2/api/scim_api.rb +88 -88
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +124 -4
- data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
- data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
- data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +78 -1
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +5 -5
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
- data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
- data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
- data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
- data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +4 -4
- data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
- data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +280 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +41 -3
|
@@ -10,6 +10,7 @@ title: QueueConversationEventTopicMessage
|
|
|
10
10
|
| **id** | **String** | | [optional] |
|
|
11
11
|
| **state** | **String** | | [optional] |
|
|
12
12
|
| **held** | **BOOLEAN** | | [optional] |
|
|
13
|
+
| **error_info** | [**QueueConversationEventTopicErrorDetails**](QueueConversationEventTopicErrorDetails.html) | | [optional] |
|
|
13
14
|
| **provider** | **String** | | [optional] |
|
|
14
15
|
| **script_id** | **String** | | [optional] |
|
|
15
16
|
| **peer_id** | **String** | | [optional] |
|
|
@@ -10,6 +10,7 @@ title: QueueConversationSocialExpressionEventTopicMessage
|
|
|
10
10
|
| **id** | **String** | | [optional] |
|
|
11
11
|
| **state** | **String** | | [optional] |
|
|
12
12
|
| **held** | **BOOLEAN** | | [optional] |
|
|
13
|
+
| **error_info** | [**QueueConversationSocialExpressionEventTopicErrorDetails**](QueueConversationSocialExpressionEventTopicErrorDetails.html) | | [optional] |
|
|
13
14
|
| **provider** | **String** | | [optional] |
|
|
14
15
|
| **script_id** | **String** | | [optional] |
|
|
15
16
|
| **peer_id** | **String** | | [optional] |
|
|
@@ -10,6 +10,7 @@ title: QueueConversationVideoEventTopicMessage
|
|
|
10
10
|
| **id** | **String** | | [optional] |
|
|
11
11
|
| **state** | **String** | | [optional] |
|
|
12
12
|
| **held** | **BOOLEAN** | | [optional] |
|
|
13
|
+
| **error_info** | [**QueueConversationVideoEventTopicErrorDetails**](QueueConversationVideoEventTopicErrorDetails.html) | | [optional] |
|
|
13
14
|
| **provider** | **String** | | [optional] |
|
|
14
15
|
| **script_id** | **String** | | [optional] |
|
|
15
16
|
| **peer_id** | **String** | | [optional] |
|
|
@@ -18,6 +18,8 @@ title: ReportingExportJobRequest
|
|
|
18
18
|
| **locale** | **String** | The locale use for localization of the exported data, i.e. en-us, es-mx | |
|
|
19
19
|
| **has_format_durations** | **BOOLEAN** | Indicates if durations are formatted in hh:mm:ss format instead of ms | [optional] |
|
|
20
20
|
| **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
|
|
21
|
+
| **exclude_empty_rows** | **BOOLEAN** | Excludes empty rows from the exports | [optional] |
|
|
22
|
+
| **has_split_by_media** | **BOOLEAN** | Indicates if media type will be split in aggregate detail exports | [optional] |
|
|
21
23
|
| **selected_columns** | [**Array<SelectedColumns>**](SelectedColumns.html) | The list of ordered selected columns from the export view by the user | [optional] |
|
|
22
24
|
| **has_custom_participant_attributes** | **BOOLEAN** | Indicates if custom participant attributes will be exported | [optional] |
|
|
23
25
|
| **recipient_emails** | **Array<String>** | The list of email recipients for the exports | [optional] |
|
|
@@ -25,10 +25,13 @@ title: ReportingExportJobResponse
|
|
|
25
25
|
| **percentage_complete** | **Float** | The percentage of the job that has completed processing | |
|
|
26
26
|
| **has_format_durations** | **BOOLEAN** | Indicates if durations are formatted in hh:mm:ss format instead of ms | [optional] |
|
|
27
27
|
| **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
|
|
28
|
+
| **exclude_empty_rows** | **BOOLEAN** | Excludes empty rows from the exports | [optional] |
|
|
29
|
+
| **has_split_by_media** | **BOOLEAN** | Indicates if media type will be split in aggregate detail exports | [optional] |
|
|
28
30
|
| **selected_columns** | [**Array<SelectedColumns>**](SelectedColumns.html) | The list of ordered selected columns from the export view by the user | [optional] |
|
|
29
31
|
| **has_custom_participant_attributes** | **BOOLEAN** | Indicates if custom participant attributes will be exported | [optional] |
|
|
30
32
|
| **recipient_emails** | **Array<String>** | The list of email recipients for the exports | [optional] |
|
|
31
33
|
| **email_statuses** | **Hash<String, String>** | The status of individual email addresses as a map | [optional] |
|
|
34
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
|
32
35
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
33
36
|
{: class="table table-striped"}
|
|
34
37
|
|
data/docs/SCIMApi.md
CHANGED
|
@@ -8,16 +8,16 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
[**delete_scim_group**](SCIMApi.html#delete_scim_group) | Delete a group
|
|
11
|
+
[**delete_scim_group**](SCIMApi.html#delete_scim_group) | Delete a group
|
|
12
12
|
[**delete_scim_user**](SCIMApi.html#delete_scim_user) | Delete a user
|
|
13
|
-
[**delete_scim_v2_group**](SCIMApi.html#delete_scim_v2_group) | Delete a group
|
|
13
|
+
[**delete_scim_v2_group**](SCIMApi.html#delete_scim_v2_group) | Delete a group
|
|
14
14
|
[**delete_scim_v2_user**](SCIMApi.html#delete_scim_v2_user) | Delete a user
|
|
15
15
|
[**get_scim_group**](SCIMApi.html#get_scim_group) | Get a group
|
|
16
16
|
[**get_scim_groups**](SCIMApi.html#get_scim_groups) | Get a list of groups
|
|
17
17
|
[**get_scim_resourcetype**](SCIMApi.html#get_scim_resourcetype) | Get a resource type
|
|
18
18
|
[**get_scim_resourcetypes**](SCIMApi.html#get_scim_resourcetypes) | Get a list of resource types
|
|
19
|
-
[**get_scim_schema**](SCIMApi.html#get_scim_schema) | Get
|
|
20
|
-
[**get_scim_schemas**](SCIMApi.html#get_scim_schemas) | Get
|
|
19
|
+
[**get_scim_schema**](SCIMApi.html#get_scim_schema) | Get a SCIM schema
|
|
20
|
+
[**get_scim_schemas**](SCIMApi.html#get_scim_schemas) | Get a list of SCIM schemas
|
|
21
21
|
[**get_scim_serviceproviderconfig**](SCIMApi.html#get_scim_serviceproviderconfig) | Get a service provider's configuration
|
|
22
22
|
[**get_scim_user**](SCIMApi.html#get_scim_user) | Get a user
|
|
23
23
|
[**get_scim_users**](SCIMApi.html#get_scim_users) | Get a list of users
|
|
@@ -25,8 +25,8 @@ Method | Description
|
|
|
25
25
|
[**get_scim_v2_groups**](SCIMApi.html#get_scim_v2_groups) | Get a list of groups
|
|
26
26
|
[**get_scim_v2_resourcetype**](SCIMApi.html#get_scim_v2_resourcetype) | Get a resource type
|
|
27
27
|
[**get_scim_v2_resourcetypes**](SCIMApi.html#get_scim_v2_resourcetypes) | Get a list of resource types
|
|
28
|
-
[**get_scim_v2_schema**](SCIMApi.html#get_scim_v2_schema) | Get
|
|
29
|
-
[**get_scim_v2_schemas**](SCIMApi.html#get_scim_v2_schemas) | Get
|
|
28
|
+
[**get_scim_v2_schema**](SCIMApi.html#get_scim_v2_schema) | Get a SCIM schema
|
|
29
|
+
[**get_scim_v2_schemas**](SCIMApi.html#get_scim_v2_schemas) | Get a list of SCIM schemas
|
|
30
30
|
[**get_scim_v2_serviceproviderconfig**](SCIMApi.html#get_scim_v2_serviceproviderconfig) | Get a service provider's configuration
|
|
31
31
|
[**get_scim_v2_user**](SCIMApi.html#get_scim_v2_user) | Get a user
|
|
32
32
|
[**get_scim_v2_users**](SCIMApi.html#get_scim_v2_users) | Get a list of users
|
|
@@ -34,9 +34,9 @@ Method | Description
|
|
|
34
34
|
[**patch_scim_user**](SCIMApi.html#patch_scim_user) | Modify a user
|
|
35
35
|
[**patch_scim_v2_group**](SCIMApi.html#patch_scim_v2_group) | Modify a group
|
|
36
36
|
[**patch_scim_v2_user**](SCIMApi.html#patch_scim_v2_user) | Modify a user
|
|
37
|
-
[**post_scim_groups**](SCIMApi.html#post_scim_groups) |
|
|
37
|
+
[**post_scim_groups**](SCIMApi.html#post_scim_groups) | Creates a group
|
|
38
38
|
[**post_scim_users**](SCIMApi.html#post_scim_users) | Create a user
|
|
39
|
-
[**post_scim_v2_groups**](SCIMApi.html#post_scim_v2_groups) |
|
|
39
|
+
[**post_scim_v2_groups**](SCIMApi.html#post_scim_v2_groups) | Create a group
|
|
40
40
|
[**post_scim_v2_users**](SCIMApi.html#post_scim_v2_users) | Create a user
|
|
41
41
|
[**put_scim_group**](SCIMApi.html#put_scim_group) | Replace a group
|
|
42
42
|
[**put_scim_user**](SCIMApi.html#put_scim_user) | Replace a user
|
|
@@ -50,7 +50,7 @@ Method | Description
|
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
|
|
53
|
-
Delete a group
|
|
53
|
+
Delete a group
|
|
54
54
|
|
|
55
55
|
|
|
56
56
|
|
|
@@ -78,14 +78,14 @@ end
|
|
|
78
78
|
|
|
79
79
|
api_instance = PureCloud::SCIMApi.new
|
|
80
80
|
|
|
81
|
-
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
81
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
|
|
82
82
|
|
|
83
83
|
opts = {
|
|
84
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
84
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
85
85
|
}
|
|
86
86
|
|
|
87
87
|
begin
|
|
88
|
-
#Delete a group
|
|
88
|
+
#Delete a group
|
|
89
89
|
api_instance.delete_scim_group(group_id, opts)
|
|
90
90
|
rescue PureCloud::ApiError => e
|
|
91
91
|
puts "Exception when calling SCIMApi->delete_scim_group: #{e}"
|
|
@@ -96,8 +96,8 @@ end
|
|
|
96
96
|
|
|
97
97
|
Name | Type | Description | Notes
|
|
98
98
|
------------- | ------------- | ------------- | -------------
|
|
99
|
-
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
100
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
99
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups. | |
|
|
100
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
101
101
|
{: class="table table-striped"}
|
|
102
102
|
|
|
103
103
|
|
|
@@ -187,7 +187,7 @@ Name | Type | Description | Notes
|
|
|
187
187
|
|
|
188
188
|
|
|
189
189
|
|
|
190
|
-
Delete a group
|
|
190
|
+
Delete a group
|
|
191
191
|
|
|
192
192
|
|
|
193
193
|
|
|
@@ -215,14 +215,14 @@ end
|
|
|
215
215
|
|
|
216
216
|
api_instance = PureCloud::SCIMApi.new
|
|
217
217
|
|
|
218
|
-
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
218
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
|
|
219
219
|
|
|
220
220
|
opts = {
|
|
221
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
221
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
222
222
|
}
|
|
223
223
|
|
|
224
224
|
begin
|
|
225
|
-
#Delete a group
|
|
225
|
+
#Delete a group
|
|
226
226
|
api_instance.delete_scim_v2_group(group_id, opts)
|
|
227
227
|
rescue PureCloud::ApiError => e
|
|
228
228
|
puts "Exception when calling SCIMApi->delete_scim_v2_group: #{e}"
|
|
@@ -233,8 +233,8 @@ end
|
|
|
233
233
|
|
|
234
234
|
Name | Type | Description | Notes
|
|
235
235
|
------------- | ------------- | ------------- | -------------
|
|
236
|
-
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
237
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
236
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups. | |
|
|
237
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
238
238
|
{: class="table table-striped"}
|
|
239
239
|
|
|
240
240
|
|
|
@@ -355,8 +355,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
355
355
|
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
356
356
|
|
|
357
357
|
opts = {
|
|
358
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the
|
|
359
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
358
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes.
|
|
359
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Always returns the \"id\", \"active\", and \"meta\" attributes. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes.
|
|
360
360
|
if_none_match: "if_none_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
361
361
|
}
|
|
362
362
|
|
|
@@ -374,8 +374,8 @@ end
|
|
|
374
374
|
Name | Type | Description | Notes
|
|
375
375
|
------------- | ------------- | ------------- | -------------
|
|
376
376
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
|
|
377
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the
|
|
378
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
377
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
378
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Always returns the \"id\", \"active\", and \"meta\" attributes. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
379
379
|
**if_none_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
|
|
380
380
|
{: class="table table-striped"}
|
|
381
381
|
|
|
@@ -427,10 +427,10 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
427
427
|
|
|
428
428
|
opts = {
|
|
429
429
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
430
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
431
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the
|
|
432
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
433
|
-
filter: "displayName eq groupName" # String | Filters results.
|
|
430
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
|
|
431
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes.
|
|
432
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Always returns the \"id\", \"active\", and \"meta\" attributes. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes.
|
|
433
|
+
filter: "displayName eq groupName" # String | Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
434
434
|
}
|
|
435
435
|
|
|
436
436
|
begin
|
|
@@ -447,10 +447,10 @@ end
|
|
|
447
447
|
Name | Type | Description | Notes
|
|
448
448
|
------------- | ------------- | ------------- | -------------
|
|
449
449
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
450
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
451
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the
|
|
452
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
453
|
-
**filter** | **String**| Filters results. | [optional] |
|
|
450
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) | [optional] [default to 25] |
|
|
451
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
452
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Always returns the \"id\", \"active\", and \"meta\" attributes. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
453
|
+
**filter** | **String**| Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\". | [optional] |
|
|
454
454
|
{: class="table table-striped"}
|
|
455
455
|
|
|
456
456
|
|
|
@@ -593,7 +593,7 @@ This endpoint does not need any parameter.
|
|
|
593
593
|
|
|
594
594
|
|
|
595
595
|
|
|
596
|
-
Get
|
|
596
|
+
Get a SCIM schema
|
|
597
597
|
|
|
598
598
|
|
|
599
599
|
|
|
@@ -620,11 +620,11 @@ end
|
|
|
620
620
|
|
|
621
621
|
api_instance = PureCloud::SCIMApi.new
|
|
622
622
|
|
|
623
|
-
schema_id = "schema_id_example" # String | The ID of a schema.
|
|
623
|
+
schema_id = "schema_id_example" # String | The ID of a schema. Returned with GET /api/v2/scim/schemas.
|
|
624
624
|
|
|
625
625
|
|
|
626
626
|
begin
|
|
627
|
-
#Get
|
|
627
|
+
#Get a SCIM schema
|
|
628
628
|
result = api_instance.get_scim_schema(schema_id)
|
|
629
629
|
p result
|
|
630
630
|
rescue PureCloud::ApiError => e
|
|
@@ -636,7 +636,7 @@ end
|
|
|
636
636
|
|
|
637
637
|
Name | Type | Description | Notes
|
|
638
638
|
------------- | ------------- | ------------- | -------------
|
|
639
|
-
**schema_id** | **String**| The ID of a schema. | <br />**Values**: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User |
|
|
639
|
+
**schema_id** | **String**| The ID of a schema. Returned with GET /api/v2/scim/schemas. | <br />**Values**: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User |
|
|
640
640
|
{: class="table table-striped"}
|
|
641
641
|
|
|
642
642
|
|
|
@@ -657,7 +657,7 @@ Name | Type | Description | Notes
|
|
|
657
657
|
|
|
658
658
|
|
|
659
659
|
|
|
660
|
-
Get
|
|
660
|
+
Get a list of SCIM schemas
|
|
661
661
|
|
|
662
662
|
|
|
663
663
|
|
|
@@ -685,11 +685,11 @@ end
|
|
|
685
685
|
api_instance = PureCloud::SCIMApi.new
|
|
686
686
|
|
|
687
687
|
opts = {
|
|
688
|
-
filter: "displayName eq groupName" # String | Filtered results are invalid and
|
|
688
|
+
filter: "displayName eq groupName" # String | Filtered results are invalid and return 403 Unauthorized.
|
|
689
689
|
}
|
|
690
690
|
|
|
691
691
|
begin
|
|
692
|
-
#Get
|
|
692
|
+
#Get a list of SCIM schemas
|
|
693
693
|
result = api_instance.get_scim_schemas(opts)
|
|
694
694
|
p result
|
|
695
695
|
rescue PureCloud::ApiError => e
|
|
@@ -701,7 +701,7 @@ end
|
|
|
701
701
|
|
|
702
702
|
Name | Type | Description | Notes
|
|
703
703
|
------------- | ------------- | ------------- | -------------
|
|
704
|
-
**filter** | **String**| Filtered results are invalid and
|
|
704
|
+
**filter** | **String**| Filtered results are invalid and return 403 Unauthorized. | [optional] |
|
|
705
705
|
{: class="table table-striped"}
|
|
706
706
|
|
|
707
707
|
|
|
@@ -793,11 +793,8 @@ Get a user
|
|
|
793
793
|
|
|
794
794
|
Wraps GET /api/v2/scim/users/{userId}
|
|
795
795
|
|
|
796
|
-
Requires
|
|
796
|
+
Requires NO permissions:
|
|
797
797
|
|
|
798
|
-
* authorization:grant:view
|
|
799
|
-
* authorization:grant:add
|
|
800
|
-
* authorization:grant:delete
|
|
801
798
|
|
|
802
799
|
|
|
803
800
|
### Example
|
|
@@ -820,8 +817,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
820
817
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
821
818
|
|
|
822
819
|
opts = {
|
|
823
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the
|
|
824
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
820
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes.
|
|
821
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes.
|
|
825
822
|
if_none_match: "if_none_match_example" # String | TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
826
823
|
}
|
|
827
824
|
|
|
@@ -839,8 +836,8 @@ end
|
|
|
839
836
|
Name | Type | Description | Notes
|
|
840
837
|
------------- | ------------- | ------------- | -------------
|
|
841
838
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
842
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the
|
|
843
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
839
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
840
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
844
841
|
**if_none_match** | **String**| TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
|
|
845
842
|
{: class="table table-striped"}
|
|
846
843
|
|
|
@@ -864,15 +861,12 @@ Name | Type | Description | Notes
|
|
|
864
861
|
|
|
865
862
|
Get a list of users
|
|
866
863
|
|
|
867
|
-
To return all active users, do not use
|
|
864
|
+
To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
868
865
|
|
|
869
866
|
Wraps GET /api/v2/scim/users
|
|
870
867
|
|
|
871
|
-
Requires
|
|
868
|
+
Requires NO permissions:
|
|
872
869
|
|
|
873
|
-
* authorization:grant:view
|
|
874
|
-
* authorization:grant:add
|
|
875
|
-
* authorization:grant:delete
|
|
876
870
|
|
|
877
871
|
|
|
878
872
|
### Example
|
|
@@ -894,9 +888,9 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
894
888
|
|
|
895
889
|
opts = {
|
|
896
890
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
897
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
898
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the
|
|
899
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
891
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
|
|
892
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes.
|
|
893
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes.
|
|
900
894
|
filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
|
|
901
895
|
}
|
|
902
896
|
|
|
@@ -914,9 +908,9 @@ end
|
|
|
914
908
|
Name | Type | Description | Notes
|
|
915
909
|
------------- | ------------- | ------------- | -------------
|
|
916
910
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
917
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
918
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the
|
|
919
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
911
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) | [optional] [default to 25] |
|
|
912
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
913
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
920
914
|
**filter** | **String**| Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\". | [optional] |
|
|
921
915
|
{: class="table table-striped"}
|
|
922
916
|
|
|
@@ -969,9 +963,9 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
969
963
|
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
970
964
|
|
|
971
965
|
opts = {
|
|
972
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the
|
|
973
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
974
|
-
if_none_match: "if_none_match_example" # String | TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
966
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes.
|
|
967
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Always returns the \"id\", \"active\", and \"meta\" attributes. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes.
|
|
968
|
+
if_none_match: "if_none_match_example" # String | TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
975
969
|
}
|
|
976
970
|
|
|
977
971
|
begin
|
|
@@ -988,9 +982,9 @@ end
|
|
|
988
982
|
Name | Type | Description | Notes
|
|
989
983
|
------------- | ------------- | ------------- | -------------
|
|
990
984
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
991
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the
|
|
992
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
993
|
-
**if_none_match** | **String**| TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
985
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
986
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Always returns the \"id\", \"active\", and \"meta\" attributes. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
987
|
+
**if_none_match** | **String**| TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
|
|
994
988
|
{: class="table table-striped"}
|
|
995
989
|
|
|
996
990
|
|
|
@@ -1039,13 +1033,13 @@ end
|
|
|
1039
1033
|
|
|
1040
1034
|
api_instance = PureCloud::SCIMApi.new
|
|
1041
1035
|
|
|
1042
|
-
filter = "displayName eq groupName" # String | Filters results.
|
|
1036
|
+
filter = "displayName eq groupName" # String | Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
1043
1037
|
|
|
1044
1038
|
opts = {
|
|
1045
1039
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
1046
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1047
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the
|
|
1048
|
-
excluded_attributes: ["excluded_attributes_example"] # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
1040
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
|
|
1041
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes.
|
|
1042
|
+
excluded_attributes: ["excluded_attributes_example"] # Array<String> | Indicates which attributes to exclude. Always returns the \"id\", \"active\", and \"meta\" attributes. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes.
|
|
1049
1043
|
}
|
|
1050
1044
|
|
|
1051
1045
|
begin
|
|
@@ -1061,11 +1055,11 @@ end
|
|
|
1061
1055
|
|
|
1062
1056
|
Name | Type | Description | Notes
|
|
1063
1057
|
------------- | ------------- | ------------- | -------------
|
|
1064
|
-
**filter** | **String**| Filters results. | |
|
|
1058
|
+
**filter** | **String**| Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\". | |
|
|
1065
1059
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
1066
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
1067
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the
|
|
1068
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
1060
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) | [optional] [default to 25] |
|
|
1061
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
1062
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Always returns the \"id\", \"active\", and \"meta\" attributes. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
1069
1063
|
{: class="table table-striped"}
|
|
1070
1064
|
|
|
1071
1065
|
|
|
@@ -1208,7 +1202,7 @@ This endpoint does not need any parameter.
|
|
|
1208
1202
|
|
|
1209
1203
|
|
|
1210
1204
|
|
|
1211
|
-
Get
|
|
1205
|
+
Get a SCIM schema
|
|
1212
1206
|
|
|
1213
1207
|
|
|
1214
1208
|
|
|
@@ -1235,11 +1229,11 @@ end
|
|
|
1235
1229
|
|
|
1236
1230
|
api_instance = PureCloud::SCIMApi.new
|
|
1237
1231
|
|
|
1238
|
-
schema_id = "schema_id_example" # String | The ID of a schema.
|
|
1232
|
+
schema_id = "schema_id_example" # String | The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.
|
|
1239
1233
|
|
|
1240
1234
|
|
|
1241
1235
|
begin
|
|
1242
|
-
#Get
|
|
1236
|
+
#Get a SCIM schema
|
|
1243
1237
|
result = api_instance.get_scim_v2_schema(schema_id)
|
|
1244
1238
|
p result
|
|
1245
1239
|
rescue PureCloud::ApiError => e
|
|
@@ -1251,7 +1245,7 @@ end
|
|
|
1251
1245
|
|
|
1252
1246
|
Name | Type | Description | Notes
|
|
1253
1247
|
------------- | ------------- | ------------- | -------------
|
|
1254
|
-
**schema_id** | **String**| The ID of a schema. | <br />**Values**: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User |
|
|
1248
|
+
**schema_id** | **String**| The ID of a schema. Returned with GET /api/v2/scim/v2/schemas. | <br />**Values**: urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User |
|
|
1255
1249
|
{: class="table table-striped"}
|
|
1256
1250
|
|
|
1257
1251
|
|
|
@@ -1272,7 +1266,7 @@ Name | Type | Description | Notes
|
|
|
1272
1266
|
|
|
1273
1267
|
|
|
1274
1268
|
|
|
1275
|
-
Get
|
|
1269
|
+
Get a list of SCIM schemas
|
|
1276
1270
|
|
|
1277
1271
|
|
|
1278
1272
|
|
|
@@ -1300,11 +1294,11 @@ end
|
|
|
1300
1294
|
api_instance = PureCloud::SCIMApi.new
|
|
1301
1295
|
|
|
1302
1296
|
opts = {
|
|
1303
|
-
filter: "displayName eq groupName" # String | Filtered results are invalid and
|
|
1297
|
+
filter: "displayName eq groupName" # String | Filtered results are invalid and return 403 Unauthorized.
|
|
1304
1298
|
}
|
|
1305
1299
|
|
|
1306
1300
|
begin
|
|
1307
|
-
#Get
|
|
1301
|
+
#Get a list of SCIM schemas
|
|
1308
1302
|
result = api_instance.get_scim_v2_schemas(opts)
|
|
1309
1303
|
p result
|
|
1310
1304
|
rescue PureCloud::ApiError => e
|
|
@@ -1316,7 +1310,7 @@ end
|
|
|
1316
1310
|
|
|
1317
1311
|
Name | Type | Description | Notes
|
|
1318
1312
|
------------- | ------------- | ------------- | -------------
|
|
1319
|
-
**filter** | **String**| Filtered results are invalid and
|
|
1313
|
+
**filter** | **String**| Filtered results are invalid and return 403 Unauthorized. | [optional] |
|
|
1320
1314
|
{: class="table table-striped"}
|
|
1321
1315
|
|
|
1322
1316
|
|
|
@@ -1408,11 +1402,8 @@ Get a user
|
|
|
1408
1402
|
|
|
1409
1403
|
Wraps GET /api/v2/scim/v2/users/{userId}
|
|
1410
1404
|
|
|
1411
|
-
Requires
|
|
1405
|
+
Requires NO permissions:
|
|
1412
1406
|
|
|
1413
|
-
* authorization:grant:view
|
|
1414
|
-
* authorization:grant:add
|
|
1415
|
-
* authorization:grant:delete
|
|
1416
1407
|
|
|
1417
1408
|
|
|
1418
1409
|
### Example
|
|
@@ -1435,8 +1426,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
1435
1426
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1436
1427
|
|
|
1437
1428
|
opts = {
|
|
1438
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the
|
|
1439
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
1429
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes.
|
|
1430
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes.
|
|
1440
1431
|
if_none_match: "if_none_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
1441
1432
|
}
|
|
1442
1433
|
|
|
@@ -1454,8 +1445,8 @@ end
|
|
|
1454
1445
|
Name | Type | Description | Notes
|
|
1455
1446
|
------------- | ------------- | ------------- | -------------
|
|
1456
1447
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
1457
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the
|
|
1458
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
1448
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
1449
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
1459
1450
|
**if_none_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
|
|
1460
1451
|
{: class="table table-striped"}
|
|
1461
1452
|
|
|
@@ -1479,15 +1470,12 @@ Name | Type | Description | Notes
|
|
|
1479
1470
|
|
|
1480
1471
|
Get a list of users
|
|
1481
1472
|
|
|
1482
|
-
To return all active users, do not use
|
|
1473
|
+
To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
1483
1474
|
|
|
1484
1475
|
Wraps GET /api/v2/scim/v2/users
|
|
1485
1476
|
|
|
1486
|
-
Requires
|
|
1477
|
+
Requires NO permissions:
|
|
1487
1478
|
|
|
1488
|
-
* authorization:grant:view
|
|
1489
|
-
* authorization:grant:add
|
|
1490
|
-
* authorization:grant:delete
|
|
1491
1479
|
|
|
1492
1480
|
|
|
1493
1481
|
### Example
|
|
@@ -1509,9 +1497,9 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
1509
1497
|
|
|
1510
1498
|
opts = {
|
|
1511
1499
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
1512
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1513
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the
|
|
1514
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
1500
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
|
|
1501
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes.
|
|
1502
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes.
|
|
1515
1503
|
filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
|
|
1516
1504
|
}
|
|
1517
1505
|
|
|
@@ -1529,9 +1517,9 @@ end
|
|
|
1529
1517
|
Name | Type | Description | Notes
|
|
1530
1518
|
------------- | ------------- | ------------- | -------------
|
|
1531
1519
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
1532
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
1533
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the
|
|
1534
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive
|
|
1520
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) | [optional] [default to 25] |
|
|
1521
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
1522
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive additional calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
1535
1523
|
**filter** | **String**| Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\". | [optional] |
|
|
1536
1524
|
{: class="table table-striped"}
|
|
1537
1525
|
|
|
@@ -1851,9 +1839,9 @@ Name | Type | Description | Notes
|
|
|
1851
1839
|
|
|
1852
1840
|
|
|
1853
1841
|
|
|
1854
|
-
|
|
1842
|
+
Creates a group
|
|
1855
1843
|
|
|
1856
|
-
|
|
1844
|
+
Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
1857
1845
|
|
|
1858
1846
|
Wraps POST /api/v2/scim/groups
|
|
1859
1847
|
|
|
@@ -1883,7 +1871,7 @@ body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to create
|
|
|
1883
1871
|
|
|
1884
1872
|
|
|
1885
1873
|
begin
|
|
1886
|
-
#
|
|
1874
|
+
#Creates a group
|
|
1887
1875
|
result = api_instance.post_scim_groups(body)
|
|
1888
1876
|
p result
|
|
1889
1877
|
rescue PureCloud::ApiError => e
|
|
@@ -1985,9 +1973,9 @@ Name | Type | Description | Notes
|
|
|
1985
1973
|
|
|
1986
1974
|
|
|
1987
1975
|
|
|
1988
|
-
|
|
1976
|
+
Create a group
|
|
1989
1977
|
|
|
1990
|
-
|
|
1978
|
+
Creates an \"official\" Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
1991
1979
|
|
|
1992
1980
|
Wraps POST /api/v2/scim/v2/groups
|
|
1993
1981
|
|
|
@@ -2013,11 +2001,11 @@ end
|
|
|
2013
2001
|
|
|
2014
2002
|
api_instance = PureCloud::SCIMApi.new
|
|
2015
2003
|
|
|
2016
|
-
body = PureCloud::ScimV2Group.new # ScimV2Group |
|
|
2004
|
+
body = PureCloud::ScimV2Group.new # ScimV2Group | Creates a group.
|
|
2017
2005
|
|
|
2018
2006
|
|
|
2019
2007
|
begin
|
|
2020
|
-
#
|
|
2008
|
+
#Create a group
|
|
2021
2009
|
result = api_instance.post_scim_v2_groups(body)
|
|
2022
2010
|
p result
|
|
2023
2011
|
rescue PureCloud::ApiError => e
|
|
@@ -2029,7 +2017,7 @@ end
|
|
|
2029
2017
|
|
|
2030
2018
|
Name | Type | Description | Notes
|
|
2031
2019
|
------------- | ------------- | ------------- | -------------
|
|
2032
|
-
**body** | [**ScimV2Group**](ScimV2Group.html)|
|
|
2020
|
+
**body** | [**ScimV2Group**](ScimV2Group.html)| Creates a group. | |
|
|
2033
2021
|
{: class="table table-striped"}
|
|
2034
2022
|
|
|
2035
2023
|
|