purecloudplatformclientv2 75.1.0 → 79.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActivityCode.md +1 -1
- data/docs/AnalyticsApi.md +66 -2
- data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -1
- data/docs/AnalyticsConversationQueryResponse.md +1 -1
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
- data/docs/ArchitectApi.md +345 -0
- data/docs/AuditApi.md +3 -1
- data/docs/AuditLogMessage.md +1 -1
- data/docs/AuthorizationApi.md +154 -9
- data/docs/AvailableTopic.md +3 -1
- data/docs/BuAgentScheduleActivity.md +18 -0
- data/docs/BuAgentSchedulePublishedScheduleReference.md +16 -0
- data/docs/BuAgentScheduleSearchResponse.md +15 -0
- data/docs/BuAgentScheduleShift.md +18 -0
- data/docs/BuAgentSchedulesSearchResponse.md +15 -0
- data/docs/BuAsyncAgentSchedulesSearchResponse.md +17 -0
- data/docs/BuFullDayTimeOffMarker.md +18 -0
- data/docs/BuScheduleReference.md +15 -0
- data/docs/Call.md +1 -1
- data/docs/CallBasic.md +1 -1
- data/docs/CallMediaParticipant.md +1 -1
- data/docs/CallbackMediaParticipant.md +1 -1
- data/docs/CampaignProgress.md +2 -1
- data/docs/ChatMediaParticipant.md +1 -1
- data/docs/CobrowseMediaParticipant.md +1 -1
- data/docs/ConversationsApi.md +71 -1
- data/docs/CopyAttachmentsRequest.md +14 -0
- data/docs/CreateManagementUnitApiRequest.md +3 -2
- data/docs/CreateManagementUnitSettingsRequest.md +1 -1
- data/docs/CreateWorkPlanShift.md +1 -1
- data/docs/DataTableExportJob.md +22 -0
- data/docs/DataTableImportJob.md +25 -0
- data/docs/DivsPermittedEntityListing.md +23 -0
- data/docs/EmailMediaParticipant.md +1 -1
- data/docs/EntityListing.md +17 -0
- data/docs/ErrorBody.md +2 -2
- data/docs/ErrorInfo.md +14 -0
- data/docs/Evaluation.md +1 -0
- data/docs/EvaluationQuestionGroupScore.md +4 -0
- data/docs/EvaluationScoringSet.md +1 -0
- data/docs/FacebookIntegrationRequest.md +2 -2
- data/docs/GDPRJourneyCustomer.md +2 -2
- data/docs/InboundDomain.md +2 -0
- data/docs/Library.md +4 -3
- data/docs/LicenseApi.md +66 -0
- data/docs/MailFromResult.md +15 -0
- data/docs/ManagementUnit.md +2 -2
- data/docs/ManagementUnitSettingsRequest.md +1 -1
- data/docs/MessageMediaParticipant.md +1 -1
- data/docs/MessagingApi.md +0 -936
- data/docs/MessagingTemplate.md +15 -0
- data/docs/Organization.md +1 -0
- data/docs/QualityApi.md +5 -6
- data/docs/Record.md +15 -0
- data/docs/ReportingExportMetadataJobListing.md +22 -0
- data/docs/ReportingExportMetadataJobResponse.md +22 -0
- data/docs/Response.md +2 -0
- data/docs/RoutingApi.md +385 -0
- data/docs/RoutingSettings.md +13 -0
- data/docs/SCIMApi.md +397 -23
- data/docs/ScimUserExtensions.md +14 -0
- data/docs/ScimUserRole.md +13 -0
- data/docs/ScimUserRoutingLanguage.md +14 -0
- data/docs/ScimUserRoutingSkill.md +14 -0
- data/docs/ScimV2CreateUser.md +2 -1
- data/docs/ScimV2SchemaAttribute.md +24 -0
- data/docs/ScimV2SchemaDefinition.md +17 -0
- data/docs/ScimV2SchemaListResponse.md +17 -0
- data/docs/ScimV2User.md +2 -1
- data/docs/ShortTermForecast.md +2 -2
- data/docs/ShortTermForecastListItemResponse.md +2 -2
- data/docs/ShortTermForecastReference.md +2 -2
- data/docs/TimeOffRequestLookup.md +3 -3
- data/docs/TimeOffRequestResponse.md +3 -3
- data/docs/UserScheduleAdherence.md +1 -1
- data/docs/UsersApi.md +358 -10
- data/docs/ViewFilter.md +4 -10
- data/docs/WeekSchedule.md +1 -1
- data/docs/WeekScheduleListItemResponse.md +1 -1
- data/docs/WeekScheduleReference.md +1 -1
- data/docs/WorkPlanShift.md +1 -1
- data/docs/WorkforceManagementApi.md +40 -41
- data/lib/purecloudplatformclientv2.rb +27 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +73 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +373 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +185 -7
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +84 -0
- data/lib/purecloudplatformclientv2/api/license_api.rb +63 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +0 -949
- data/lib/purecloudplatformclientv2/api/quality_api.rb +8 -6
- data/lib/purecloudplatformclientv2/api/routing_api.rb +378 -0
- data/lib/purecloudplatformclientv2/api/scim_api.rb +366 -26
- data/lib/purecloudplatformclientv2/api/users_api.rb +398 -7
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/activity_code.rb +30 -30
- data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +27 -1
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +5 -5
- data/lib/purecloudplatformclientv2/models/available_topic.rb +57 -4
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_published_schedule_reference.rb +280 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_shift.rb +334 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedules_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_search_response.rb +320 -0
- data/lib/purecloudplatformclientv2/models/bu_full_day_time_off_marker.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb +254 -0
- data/lib/purecloudplatformclientv2/models/call.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_basic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +28 -2
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb +240 -0
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +37 -16
- data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +1 -1
- data/lib/purecloudplatformclientv2/models/data_table_export_job.rb +455 -0
- data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +547 -0
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +453 -0
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +303 -0
- data/lib/purecloudplatformclientv2/models/error_body.rb +20 -20
- data/lib/purecloudplatformclientv2/models/error_info.rb +226 -0
- data/lib/purecloudplatformclientv2/models/evaluation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/evaluation_question_group_score.rb +101 -1
- data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +26 -1
- data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +2 -7
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +2 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain.rb +53 -1
- data/lib/purecloudplatformclientv2/models/library.rb +44 -2
- data/lib/purecloudplatformclientv2/models/mail_from_result.rb +275 -0
- data/lib/purecloudplatformclientv2/models/management_unit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/management_unit_settings_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/messaging_template.rb +270 -0
- data/lib/purecloudplatformclientv2/models/organization.rb +41 -1
- data/lib/purecloudplatformclientv2/models/record.rb +269 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_response.rb +459 -0
- data/lib/purecloudplatformclientv2/models/response.rb +67 -1
- data/lib/purecloudplatformclientv2/models/routing_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +233 -0
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +203 -0
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +234 -0
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +234 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +30 -5
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +551 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +309 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -2
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +30 -35
- data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +30 -35
- data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +22 -27
- data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
- data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +1 -1
- data/lib/purecloudplatformclientv2/models/view_filter.rb +53 -255
- data/lib/purecloudplatformclientv2/models/week_schedule.rb +21 -21
- data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +21 -21
- data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +14 -14
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +56 -2
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: RoutingSettings
|
3
|
+
---
|
4
|
+
## PureCloud::RoutingSettings
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **reset_agent_score_on_presence_change** | **BOOLEAN** | Reset agent score when agent presence changes from off-queue to on-queue | [optional] |
|
11
|
+
{: class="table table-striped"}
|
12
|
+
|
13
|
+
|
data/docs/SCIMApi.md
CHANGED
@@ -16,6 +16,8 @@ Method | Description
|
|
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 the SCIM schema by id
|
20
|
+
[**get_scim_schemas**](SCIMApi.html#get_scim_schemas) | Get the SCIM schemas
|
19
21
|
[**get_scim_serviceproviderconfig**](SCIMApi.html#get_scim_serviceproviderconfig) | Get a service provider's configuration
|
20
22
|
[**get_scim_user**](SCIMApi.html#get_scim_user) | Get a user
|
21
23
|
[**get_scim_users**](SCIMApi.html#get_scim_users) | Get a list of users
|
@@ -23,6 +25,8 @@ Method | Description
|
|
23
25
|
[**get_scim_v2_groups**](SCIMApi.html#get_scim_v2_groups) | Get a list of groups
|
24
26
|
[**get_scim_v2_resourcetype**](SCIMApi.html#get_scim_v2_resourcetype) | Get a resource type
|
25
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 the SCIM schema by id
|
29
|
+
[**get_scim_v2_schemas**](SCIMApi.html#get_scim_v2_schemas) | Get the SCIM schemas
|
26
30
|
[**get_scim_v2_serviceproviderconfig**](SCIMApi.html#get_scim_v2_serviceproviderconfig) | Get a service provider's configuration
|
27
31
|
[**get_scim_v2_user**](SCIMApi.html#get_scim_v2_user) | Get a user
|
28
32
|
[**get_scim_v2_users**](SCIMApi.html#get_scim_v2_users) | Get a list of users
|
@@ -351,6 +355,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
351
355
|
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups.
|
352
356
|
|
353
357
|
opts = {
|
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 secondary calls for the default attributes.
|
359
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
|
354
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.
|
355
361
|
}
|
356
362
|
|
@@ -368,6 +374,8 @@ end
|
|
368
374
|
Name | Type | Description | Notes
|
369
375
|
------------- | ------------- | ------------- | -------------
|
370
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 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary 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. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output. | [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 |
|
371
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] |
|
372
380
|
{: class="table table-striped"}
|
373
381
|
|
@@ -420,6 +428,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
420
428
|
opts = {
|
421
429
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
422
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 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
432
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
|
423
433
|
filter: "displayName eq groupName" # String | Filters results.
|
424
434
|
}
|
425
435
|
|
@@ -438,6 +448,8 @@ Name | Type | Description | Notes
|
|
438
448
|
------------- | ------------- | ------------- | -------------
|
439
449
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
440
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 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary 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. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output. | [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 |
|
441
453
|
**filter** | **String**| Filters results. | [optional] |
|
442
454
|
{: class="table table-striped"}
|
443
455
|
|
@@ -473,6 +485,16 @@ Requires NO permissions:
|
|
473
485
|
```{"language":"ruby"}
|
474
486
|
# load the gem
|
475
487
|
require 'purecloudplatformclientv2'
|
488
|
+
# setup authorization
|
489
|
+
@secret = ENV['PURECLOUD_SECRET']
|
490
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
491
|
+
environment = "mypurecloud.com"
|
492
|
+
|
493
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
494
|
+
|
495
|
+
PureCloud.configure do |config|
|
496
|
+
config.access_token = @authToken
|
497
|
+
end
|
476
498
|
|
477
499
|
api_instance = PureCloud::SCIMApi.new
|
478
500
|
|
@@ -492,7 +514,7 @@ end
|
|
492
514
|
|
493
515
|
Name | Type | Description | Notes
|
494
516
|
------------- | ------------- | ------------- | -------------
|
495
|
-
**resource_type** | **String**| The type of resource. Returned with GET /api/v2/scim/resourcetypes. | <br />**Values**: User, Group, ServiceProviderConfig, ResourceType |
|
517
|
+
**resource_type** | **String**| The type of resource. Returned with GET /api/v2/scim/resourcetypes. | <br />**Values**: User, Group, ServiceProviderConfig, ResourceType, Schema |
|
496
518
|
{: class="table table-striped"}
|
497
519
|
|
498
520
|
|
@@ -527,6 +549,16 @@ Requires NO permissions:
|
|
527
549
|
```{"language":"ruby"}
|
528
550
|
# load the gem
|
529
551
|
require 'purecloudplatformclientv2'
|
552
|
+
# setup authorization
|
553
|
+
@secret = ENV['PURECLOUD_SECRET']
|
554
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
555
|
+
environment = "mypurecloud.com"
|
556
|
+
|
557
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
558
|
+
|
559
|
+
PureCloud.configure do |config|
|
560
|
+
config.access_token = @authToken
|
561
|
+
end
|
530
562
|
|
531
563
|
api_instance = PureCloud::SCIMApi.new
|
532
564
|
|
@@ -555,6 +587,135 @@ This endpoint does not need any parameter.
|
|
555
587
|
|
556
588
|
|
557
589
|
|
590
|
+
<a name="get_scim_schema"></a>
|
591
|
+
|
592
|
+
## [**ScimConfigResourceType**](ScimConfigResourceType.html) get_scim_schema(schema_id)
|
593
|
+
|
594
|
+
|
595
|
+
|
596
|
+
Get the SCIM schema by id
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
Wraps GET /api/v2/scim/schemas/{schemaId}
|
601
|
+
|
602
|
+
Requires NO permissions:
|
603
|
+
|
604
|
+
|
605
|
+
|
606
|
+
### Example
|
607
|
+
```{"language":"ruby"}
|
608
|
+
# load the gem
|
609
|
+
require 'purecloudplatformclientv2'
|
610
|
+
# setup authorization
|
611
|
+
@secret = ENV['PURECLOUD_SECRET']
|
612
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
613
|
+
environment = "mypurecloud.com"
|
614
|
+
|
615
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
616
|
+
|
617
|
+
PureCloud.configure do |config|
|
618
|
+
config.access_token = @authToken
|
619
|
+
end
|
620
|
+
|
621
|
+
api_instance = PureCloud::SCIMApi.new
|
622
|
+
|
623
|
+
schema_id = "schema_id_example" # String | The ID of a schema.
|
624
|
+
|
625
|
+
|
626
|
+
begin
|
627
|
+
#Get the SCIM schema by id
|
628
|
+
result = api_instance.get_scim_schema(schema_id)
|
629
|
+
p result
|
630
|
+
rescue PureCloud::ApiError => e
|
631
|
+
puts "Exception when calling SCIMApi->get_scim_schema: #{e}"
|
632
|
+
end
|
633
|
+
```
|
634
|
+
|
635
|
+
### Parameters
|
636
|
+
|
637
|
+
Name | Type | Description | Notes
|
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 |
|
640
|
+
{: class="table table-striped"}
|
641
|
+
|
642
|
+
|
643
|
+
### Return type
|
644
|
+
|
645
|
+
[**ScimConfigResourceType**](ScimConfigResourceType.html)
|
646
|
+
|
647
|
+
### HTTP request headers
|
648
|
+
|
649
|
+
- **Content-Type**: application/json, application/scim+json
|
650
|
+
- **Accept**: application/json, application/scim+json
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
<a name="get_scim_schemas"></a>
|
655
|
+
|
656
|
+
## [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html) get_scim_schemas(opts)
|
657
|
+
|
658
|
+
|
659
|
+
|
660
|
+
Get the SCIM schemas
|
661
|
+
|
662
|
+
|
663
|
+
|
664
|
+
Wraps GET /api/v2/scim/schemas
|
665
|
+
|
666
|
+
Requires NO permissions:
|
667
|
+
|
668
|
+
|
669
|
+
|
670
|
+
### Example
|
671
|
+
```{"language":"ruby"}
|
672
|
+
# load the gem
|
673
|
+
require 'purecloudplatformclientv2'
|
674
|
+
# setup authorization
|
675
|
+
@secret = ENV['PURECLOUD_SECRET']
|
676
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
677
|
+
environment = "mypurecloud.com"
|
678
|
+
|
679
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
680
|
+
|
681
|
+
PureCloud.configure do |config|
|
682
|
+
config.access_token = @authToken
|
683
|
+
end
|
684
|
+
|
685
|
+
api_instance = PureCloud::SCIMApi.new
|
686
|
+
|
687
|
+
opts = {
|
688
|
+
filter: "displayName eq groupName" # String | Filtered results are invalid and will result in a 403 (Unauthorized) return.
|
689
|
+
}
|
690
|
+
|
691
|
+
begin
|
692
|
+
#Get the SCIM schemas
|
693
|
+
result = api_instance.get_scim_schemas(opts)
|
694
|
+
p result
|
695
|
+
rescue PureCloud::ApiError => e
|
696
|
+
puts "Exception when calling SCIMApi->get_scim_schemas: #{e}"
|
697
|
+
end
|
698
|
+
```
|
699
|
+
|
700
|
+
### Parameters
|
701
|
+
|
702
|
+
Name | Type | Description | Notes
|
703
|
+
------------- | ------------- | ------------- | -------------
|
704
|
+
**filter** | **String**| Filtered results are invalid and will result in a 403 (Unauthorized) return. | [optional] |
|
705
|
+
{: class="table table-striped"}
|
706
|
+
|
707
|
+
|
708
|
+
### Return type
|
709
|
+
|
710
|
+
[**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html)
|
711
|
+
|
712
|
+
### HTTP request headers
|
713
|
+
|
714
|
+
- **Content-Type**: application/json, application/scim+json
|
715
|
+
- **Accept**: application/json, application/scim+json
|
716
|
+
|
717
|
+
|
718
|
+
|
558
719
|
<a name="get_scim_serviceproviderconfig"></a>
|
559
720
|
|
560
721
|
## [**ScimServiceProviderConfig**](ScimServiceProviderConfig.html) get_scim_serviceproviderconfig(opts)
|
@@ -575,6 +736,16 @@ Requires NO permissions:
|
|
575
736
|
```{"language":"ruby"}
|
576
737
|
# load the gem
|
577
738
|
require 'purecloudplatformclientv2'
|
739
|
+
# setup authorization
|
740
|
+
@secret = ENV['PURECLOUD_SECRET']
|
741
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
742
|
+
environment = "mypurecloud.com"
|
743
|
+
|
744
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
745
|
+
|
746
|
+
PureCloud.configure do |config|
|
747
|
+
config.access_token = @authToken
|
748
|
+
end
|
578
749
|
|
579
750
|
api_instance = PureCloud::SCIMApi.new
|
580
751
|
|
@@ -622,8 +793,11 @@ Get a user
|
|
622
793
|
|
623
794
|
Wraps GET /api/v2/scim/users/{userId}
|
624
795
|
|
625
|
-
Requires
|
796
|
+
Requires ANY permissions:
|
626
797
|
|
798
|
+
* authorization:grant:view
|
799
|
+
* authorization:grant:add
|
800
|
+
* authorization:grant:delete
|
627
801
|
|
628
802
|
|
629
803
|
### Example
|
@@ -646,8 +820,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
646
820
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
647
821
|
|
648
822
|
opts = {
|
649
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes
|
650
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes
|
823
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
824
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
|
651
825
|
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.
|
652
826
|
}
|
653
827
|
|
@@ -665,8 +839,8 @@ end
|
|
665
839
|
Name | Type | Description | Notes
|
666
840
|
------------- | ------------- | ------------- | -------------
|
667
841
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
668
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes
|
669
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes
|
842
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn: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: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 |
|
843
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn: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: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 |
|
670
844
|
**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] |
|
671
845
|
{: class="table table-striped"}
|
672
846
|
|
@@ -694,8 +868,11 @@ To return all active users, do not use a filter parameter. To return inactive us
|
|
694
868
|
|
695
869
|
Wraps GET /api/v2/scim/users
|
696
870
|
|
697
|
-
Requires
|
871
|
+
Requires ANY permissions:
|
698
872
|
|
873
|
+
* authorization:grant:view
|
874
|
+
* authorization:grant:add
|
875
|
+
* authorization:grant:delete
|
699
876
|
|
700
877
|
|
701
878
|
### Example
|
@@ -718,8 +895,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
718
895
|
opts = {
|
719
896
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
720
897
|
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
721
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes
|
722
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes
|
898
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
899
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
|
723
900
|
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\".
|
724
901
|
}
|
725
902
|
|
@@ -738,8 +915,8 @@ Name | Type | Description | Notes
|
|
738
915
|
------------- | ------------- | ------------- | -------------
|
739
916
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
740
917
|
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
741
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes
|
742
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes
|
918
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn: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: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 |
|
919
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn: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: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 |
|
743
920
|
**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] |
|
744
921
|
{: class="table table-striped"}
|
745
922
|
|
@@ -792,6 +969,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
792
969
|
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
793
970
|
|
794
971
|
opts = {
|
972
|
+
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 secondary calls for the default attributes.
|
973
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
|
795
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.
|
796
975
|
}
|
797
976
|
|
@@ -809,6 +988,8 @@ end
|
|
809
988
|
Name | Type | Description | Notes
|
810
989
|
------------- | ------------- | ------------- | -------------
|
811
990
|
**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 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary 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 |
|
992
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output. | [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 |
|
812
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. | [optional] |
|
813
994
|
{: class="table table-striped"}
|
814
995
|
|
@@ -862,7 +1043,9 @@ filter = "displayName eq groupName" # String | Filters results.
|
|
862
1043
|
|
863
1044
|
opts = {
|
864
1045
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
865
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
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 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
1048
|
+
excluded_attributes: ["excluded_attributes_example"] # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
|
866
1049
|
}
|
867
1050
|
|
868
1051
|
begin
|
@@ -881,6 +1064,8 @@ Name | Type | Description | Notes
|
|
881
1064
|
**filter** | **String**| Filters results. | |
|
882
1065
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
883
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 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary 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 |
|
1068
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output. | [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 |
|
884
1069
|
{: class="table table-striped"}
|
885
1070
|
|
886
1071
|
|
@@ -915,6 +1100,16 @@ Requires NO permissions:
|
|
915
1100
|
```{"language":"ruby"}
|
916
1101
|
# load the gem
|
917
1102
|
require 'purecloudplatformclientv2'
|
1103
|
+
# setup authorization
|
1104
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1105
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1106
|
+
environment = "mypurecloud.com"
|
1107
|
+
|
1108
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1109
|
+
|
1110
|
+
PureCloud.configure do |config|
|
1111
|
+
config.access_token = @authToken
|
1112
|
+
end
|
918
1113
|
|
919
1114
|
api_instance = PureCloud::SCIMApi.new
|
920
1115
|
|
@@ -934,7 +1129,7 @@ end
|
|
934
1129
|
|
935
1130
|
Name | Type | Description | Notes
|
936
1131
|
------------- | ------------- | ------------- | -------------
|
937
|
-
**resource_type** | **String**| The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. | <br />**Values**: User, Group, ServiceProviderConfig, ResourceType |
|
1132
|
+
**resource_type** | **String**| The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. | <br />**Values**: User, Group, ServiceProviderConfig, ResourceType, Schema |
|
938
1133
|
{: class="table table-striped"}
|
939
1134
|
|
940
1135
|
|
@@ -969,6 +1164,16 @@ Requires NO permissions:
|
|
969
1164
|
```{"language":"ruby"}
|
970
1165
|
# load the gem
|
971
1166
|
require 'purecloudplatformclientv2'
|
1167
|
+
# setup authorization
|
1168
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1169
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1170
|
+
environment = "mypurecloud.com"
|
1171
|
+
|
1172
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1173
|
+
|
1174
|
+
PureCloud.configure do |config|
|
1175
|
+
config.access_token = @authToken
|
1176
|
+
end
|
972
1177
|
|
973
1178
|
api_instance = PureCloud::SCIMApi.new
|
974
1179
|
|
@@ -997,6 +1202,135 @@ This endpoint does not need any parameter.
|
|
997
1202
|
|
998
1203
|
|
999
1204
|
|
1205
|
+
<a name="get_scim_v2_schema"></a>
|
1206
|
+
|
1207
|
+
## [**ScimV2SchemaDefinition**](ScimV2SchemaDefinition.html) get_scim_v2_schema(schema_id)
|
1208
|
+
|
1209
|
+
|
1210
|
+
|
1211
|
+
Get the SCIM schema by id
|
1212
|
+
|
1213
|
+
|
1214
|
+
|
1215
|
+
Wraps GET /api/v2/scim/v2/schemas/{schemaId}
|
1216
|
+
|
1217
|
+
Requires NO permissions:
|
1218
|
+
|
1219
|
+
|
1220
|
+
|
1221
|
+
### Example
|
1222
|
+
```{"language":"ruby"}
|
1223
|
+
# load the gem
|
1224
|
+
require 'purecloudplatformclientv2'
|
1225
|
+
# setup authorization
|
1226
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1227
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1228
|
+
environment = "mypurecloud.com"
|
1229
|
+
|
1230
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1231
|
+
|
1232
|
+
PureCloud.configure do |config|
|
1233
|
+
config.access_token = @authToken
|
1234
|
+
end
|
1235
|
+
|
1236
|
+
api_instance = PureCloud::SCIMApi.new
|
1237
|
+
|
1238
|
+
schema_id = "schema_id_example" # String | The ID of a schema.
|
1239
|
+
|
1240
|
+
|
1241
|
+
begin
|
1242
|
+
#Get the SCIM schema by id
|
1243
|
+
result = api_instance.get_scim_v2_schema(schema_id)
|
1244
|
+
p result
|
1245
|
+
rescue PureCloud::ApiError => e
|
1246
|
+
puts "Exception when calling SCIMApi->get_scim_v2_schema: #{e}"
|
1247
|
+
end
|
1248
|
+
```
|
1249
|
+
|
1250
|
+
### Parameters
|
1251
|
+
|
1252
|
+
Name | Type | Description | Notes
|
1253
|
+
------------- | ------------- | ------------- | -------------
|
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 |
|
1255
|
+
{: class="table table-striped"}
|
1256
|
+
|
1257
|
+
|
1258
|
+
### Return type
|
1259
|
+
|
1260
|
+
[**ScimV2SchemaDefinition**](ScimV2SchemaDefinition.html)
|
1261
|
+
|
1262
|
+
### HTTP request headers
|
1263
|
+
|
1264
|
+
- **Content-Type**: application/json, application/scim+json
|
1265
|
+
- **Accept**: application/json, application/scim+json
|
1266
|
+
|
1267
|
+
|
1268
|
+
|
1269
|
+
<a name="get_scim_v2_schemas"></a>
|
1270
|
+
|
1271
|
+
## [**ScimV2SchemaListResponse**](ScimV2SchemaListResponse.html) get_scim_v2_schemas(opts)
|
1272
|
+
|
1273
|
+
|
1274
|
+
|
1275
|
+
Get the SCIM schemas
|
1276
|
+
|
1277
|
+
|
1278
|
+
|
1279
|
+
Wraps GET /api/v2/scim/v2/schemas
|
1280
|
+
|
1281
|
+
Requires NO permissions:
|
1282
|
+
|
1283
|
+
|
1284
|
+
|
1285
|
+
### Example
|
1286
|
+
```{"language":"ruby"}
|
1287
|
+
# load the gem
|
1288
|
+
require 'purecloudplatformclientv2'
|
1289
|
+
# setup authorization
|
1290
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1291
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1292
|
+
environment = "mypurecloud.com"
|
1293
|
+
|
1294
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1295
|
+
|
1296
|
+
PureCloud.configure do |config|
|
1297
|
+
config.access_token = @authToken
|
1298
|
+
end
|
1299
|
+
|
1300
|
+
api_instance = PureCloud::SCIMApi.new
|
1301
|
+
|
1302
|
+
opts = {
|
1303
|
+
filter: "displayName eq groupName" # String | Filtered results are invalid and will result in a 403 (Unauthorized) return.
|
1304
|
+
}
|
1305
|
+
|
1306
|
+
begin
|
1307
|
+
#Get the SCIM schemas
|
1308
|
+
result = api_instance.get_scim_v2_schemas(opts)
|
1309
|
+
p result
|
1310
|
+
rescue PureCloud::ApiError => e
|
1311
|
+
puts "Exception when calling SCIMApi->get_scim_v2_schemas: #{e}"
|
1312
|
+
end
|
1313
|
+
```
|
1314
|
+
|
1315
|
+
### Parameters
|
1316
|
+
|
1317
|
+
Name | Type | Description | Notes
|
1318
|
+
------------- | ------------- | ------------- | -------------
|
1319
|
+
**filter** | **String**| Filtered results are invalid and will result in a 403 (Unauthorized) return. | [optional] |
|
1320
|
+
{: class="table table-striped"}
|
1321
|
+
|
1322
|
+
|
1323
|
+
### Return type
|
1324
|
+
|
1325
|
+
[**ScimV2SchemaListResponse**](ScimV2SchemaListResponse.html)
|
1326
|
+
|
1327
|
+
### HTTP request headers
|
1328
|
+
|
1329
|
+
- **Content-Type**: application/json, application/scim+json
|
1330
|
+
- **Accept**: application/json, application/scim+json
|
1331
|
+
|
1332
|
+
|
1333
|
+
|
1000
1334
|
<a name="get_scim_v2_serviceproviderconfig"></a>
|
1001
1335
|
|
1002
1336
|
## [**ScimServiceProviderConfig**](ScimServiceProviderConfig.html) get_scim_v2_serviceproviderconfig(opts)
|
@@ -1017,6 +1351,16 @@ Requires NO permissions:
|
|
1017
1351
|
```{"language":"ruby"}
|
1018
1352
|
# load the gem
|
1019
1353
|
require 'purecloudplatformclientv2'
|
1354
|
+
# setup authorization
|
1355
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1356
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1357
|
+
environment = "mypurecloud.com"
|
1358
|
+
|
1359
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1360
|
+
|
1361
|
+
PureCloud.configure do |config|
|
1362
|
+
config.access_token = @authToken
|
1363
|
+
end
|
1020
1364
|
|
1021
1365
|
api_instance = PureCloud::SCIMApi.new
|
1022
1366
|
|
@@ -1064,8 +1408,11 @@ Get a user
|
|
1064
1408
|
|
1065
1409
|
Wraps GET /api/v2/scim/v2/users/{userId}
|
1066
1410
|
|
1067
|
-
Requires
|
1411
|
+
Requires ANY permissions:
|
1068
1412
|
|
1413
|
+
* authorization:grant:view
|
1414
|
+
* authorization:grant:add
|
1415
|
+
* authorization:grant:delete
|
1069
1416
|
|
1070
1417
|
|
1071
1418
|
### Example
|
@@ -1088,8 +1435,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
1088
1435
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
1089
1436
|
|
1090
1437
|
opts = {
|
1091
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes
|
1092
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes
|
1438
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
1439
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
|
1093
1440
|
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.
|
1094
1441
|
}
|
1095
1442
|
|
@@ -1107,8 +1454,8 @@ end
|
|
1107
1454
|
Name | Type | Description | Notes
|
1108
1455
|
------------- | ------------- | ------------- | -------------
|
1109
1456
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
1110
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes
|
1111
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes
|
1457
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn: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: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 |
|
1458
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn: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: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 |
|
1112
1459
|
**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] |
|
1113
1460
|
{: class="table table-striped"}
|
1114
1461
|
|
@@ -1136,8 +1483,11 @@ To return all active users, do not use a filter parameter. To return inactive us
|
|
1136
1483
|
|
1137
1484
|
Wraps GET /api/v2/scim/v2/users
|
1138
1485
|
|
1139
|
-
Requires
|
1486
|
+
Requires ANY permissions:
|
1140
1487
|
|
1488
|
+
* authorization:grant:view
|
1489
|
+
* authorization:grant:add
|
1490
|
+
* authorization:grant:delete
|
1141
1491
|
|
1142
1492
|
|
1143
1493
|
### Example
|
@@ -1160,8 +1510,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
1160
1510
|
opts = {
|
1161
1511
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
1162
1512
|
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
1163
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes
|
1164
|
-
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes
|
1513
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
1514
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
|
1165
1515
|
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\".
|
1166
1516
|
}
|
1167
1517
|
|
@@ -1180,8 +1530,8 @@ Name | Type | Description | Notes
|
|
1180
1530
|
------------- | ------------- | ------------- | -------------
|
1181
1531
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
1182
1532
|
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
1183
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes
|
1184
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes
|
1533
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes ant the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn: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: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 |
|
1534
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, rolesurn: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: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 |
|
1185
1535
|
**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] |
|
1186
1536
|
{: class="table table-striped"}
|
1187
1537
|
|
@@ -1285,6 +1635,10 @@ Requires ANY permissions:
|
|
1285
1635
|
|
1286
1636
|
* directory:user:edit
|
1287
1637
|
* directory:user:setPassword
|
1638
|
+
* authorization:grant:add
|
1639
|
+
* authorization:grant:delete
|
1640
|
+
* routing:skill:assign
|
1641
|
+
* routing:language:assign
|
1288
1642
|
|
1289
1643
|
|
1290
1644
|
### Example
|
@@ -1430,6 +1784,10 @@ Requires ANY permissions:
|
|
1430
1784
|
|
1431
1785
|
* directory:user:edit
|
1432
1786
|
* directory:user:setPassword
|
1787
|
+
* authorization:grant:add
|
1788
|
+
* authorization:grant:delete
|
1789
|
+
* routing:skill:assign
|
1790
|
+
* routing:language:assign
|
1433
1791
|
|
1434
1792
|
|
1435
1793
|
### Example
|
@@ -1567,6 +1925,10 @@ Wraps POST /api/v2/scim/users
|
|
1567
1925
|
Requires ANY permissions:
|
1568
1926
|
|
1569
1927
|
* directory:user:add
|
1928
|
+
* authorization:grant:add
|
1929
|
+
* authorization:grant:delete
|
1930
|
+
* routing:skill:assign
|
1931
|
+
* routing:language:assign
|
1570
1932
|
|
1571
1933
|
|
1572
1934
|
### Example
|
@@ -1697,6 +2059,10 @@ Wraps POST /api/v2/scim/v2/users
|
|
1697
2059
|
Requires ANY permissions:
|
1698
2060
|
|
1699
2061
|
* directory:user:add
|
2062
|
+
* authorization:grant:add
|
2063
|
+
* authorization:grant:delete
|
2064
|
+
* routing:skill:assign
|
2065
|
+
* routing:language:assign
|
1700
2066
|
|
1701
2067
|
|
1702
2068
|
### Example
|
@@ -1835,6 +2201,10 @@ Requires ANY permissions:
|
|
1835
2201
|
|
1836
2202
|
* directory:user:edit
|
1837
2203
|
* directory:user:setPassword
|
2204
|
+
* authorization:grant:add
|
2205
|
+
* authorization:grant:delete
|
2206
|
+
* routing:skill:assign
|
2207
|
+
* routing:language:assign
|
1838
2208
|
|
1839
2209
|
|
1840
2210
|
### Example
|
@@ -1980,6 +2350,10 @@ Requires ANY permissions:
|
|
1980
2350
|
|
1981
2351
|
* directory:user:edit
|
1982
2352
|
* directory:user:setPassword
|
2353
|
+
* authorization:grant:add
|
2354
|
+
* authorization:grant:delete
|
2355
|
+
* routing:skill:assign
|
2356
|
+
* routing:language:assign
|
1983
2357
|
|
1984
2358
|
|
1985
2359
|
### Example
|