purecloudplatformclientv2 66.0.0 → 71.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/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsSession.md +1 -0
- data/docs/ArchitectApi.md +21 -17
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +140 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/BuSearchAgentSchedulesRequest.md +15 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +2 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +2 -0
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatMediaParticipant.md +2 -0
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +2 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactCenterSettings.md +13 -0
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationAggregationQuery.md +1 -0
- data/docs/ConversationCallEventTopicCallConversation.md +1 -0
- data/docs/ConversationCallEventTopicCallMediaParticipant.md +2 -0
- data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +2 -0
- data/docs/ConversationChatEventTopicChatMediaParticipant.md +2 -0
- data/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md +2 -0
- data/docs/ConversationDeletionProtectionQuery.md +13 -0
- data/docs/ConversationEmailEventTopicEmailMediaParticipant.md +2 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicParticipant.md +2 -0
- data/docs/ConversationMessageEventTopicMessageMediaParticipant.md +2 -0
- data/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md +2 -0
- data/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md +2 -0
- data/docs/ConversationVideoEventTopicVideoMediaParticipant.md +2 -0
- data/docs/ConversationsApi.md +198 -0
- data/docs/CreateManagementUnitApiRequest.md +1 -1
- data/docs/{CreateManagementUnitSettings.md → CreateManagementUnitSettingsRequest.md} +3 -3
- data/docs/CreateWorkPlan.md +1 -0
- data/docs/CreateWorkPlanShift.md +1 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialerResponsesetConfigChangeResponseSet.md +1 -0
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainLogicalInterface.md +4 -0
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +2 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowAggregationQuery.md +1 -0
- data/docs/FlowDivisionView.md +2 -0
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationType.md +1 -0
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationAddressVerificationDetails.md +16 -0
- data/docs/LocationCreateDefinition.md +20 -0
- data/docs/LocationDefinition.md +12 -9
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationUpdateDefinition.md +20 -0
- data/docs/LocationsApi.md +6 -6
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnit.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/{UserExternalIdentifier.md → ManagementUnitReference.md} +3 -4
- data/docs/{ManagementUnitSettings.md → ManagementUnitSettingsRequest.md} +3 -3
- data/docs/ManagementUnitSettingsResponse.md +18 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageEvaluation.md +16 -0
- data/docs/MessageMediaParticipant.md +2 -0
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/Participant.md +2 -0
- data/docs/ParticipantBasic.md +2 -0
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PlanningPeriodSettings.md +14 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +51 -23
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationCallEventTopicCallConversation.md +1 -0
- data/docs/QueueConversationCallEventTopicCallMediaParticipant.md +2 -0
- data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +2 -0
- data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +2 -0
- data/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md +2 -0
- data/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +2 -0
- data/docs/QueueConversationEventTopicParticipant.md +2 -0
- data/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md +2 -0
- data/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md +2 -0
- data/docs/QueueConversationSocialExpressionEventTopicParticipant.md +2 -0
- data/docs/QueueConversationVideoEventTopicParticipant.md +2 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/QueueUserEventTopicQueueMember.md +4 -4
- data/docs/QueueUserEventTopicUserReference.md +13 -0
- data/docs/RecipientListing.md +1 -1
- data/docs/Recording.md +1 -0
- data/docs/RecordingApi.md +164 -14
- data/docs/RecordingJobEntityListing.md +1 -1
- data/docs/RecordingJobsQuery.md +1 -1
- data/docs/RecordingMetadata.md +1 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +2 -0
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoleDivisionGrants.md +13 -0
- data/docs/RoleDivisionPair.md +14 -0
- data/docs/RoutingApi.md +250 -2
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +302 -26
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/{SchedulingSettings.md → SchedulingSettingsRequest.md} +2 -2
- data/docs/SchedulingSettingsResponse.md +15 -0
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +1 -1
- data/docs/ScimConfigResourceTypeSchemaExtension.md +1 -1
- data/docs/ScimError.md +4 -4
- data/docs/ScimServiceProviderConfig.md +7 -7
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +1 -1
- data/docs/ScimV2CreateUser.md +1 -1
- data/docs/ScimV2Group.md +3 -2
- data/docs/ScimV2User.md +2 -2
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SearchApi.md +3 -3
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/SelectedColumns.md +14 -0
- data/docs/SendAgentlessOutboundMessageRequest.md +16 -0
- data/docs/SendAgentlessOutboundMessageResponse.md +21 -0
- data/docs/ShareEntityListing.md +1 -1
- data/docs/ShiftTradeSettings.md +1 -0
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddressEntityListing.md +1 -1
- data/docs/SmsPhoneNumber.md +1 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +1 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SubscriptionOverviewUsage.md +2 -0
- data/docs/SuggestApi.md +2 -2
- data/docs/SurveyAggregationQuery.md +1 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeOffRequestLookup.md +13 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TranscriptionSettings.md +14 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateManagementUnitRequest.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAggregationQuery.md +1 -0
- data/docs/UserDetailsQuery.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +101 -306
- data/docs/ValueWrapperPlanningPeriodSettings.md +13 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmForecastModificationIntervalOffsetValue.md +1 -1
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WhatsAppIntegrationRequest.md +17 -0
- data/docs/WorkPlan.md +1 -0
- data/docs/WorkPlanListItemResponse.md +1 -0
- data/docs/WorkPlanReference.md +3 -1
- data/docs/WorkPlanShift.md +1 -0
- data/docs/WorkforceManagementApi.md +80 -9
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +23 -5
- data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +195 -0
- data/lib/purecloudplatformclientv2/api/notifications_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/quality_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/recording_api.rb +138 -2
- data/lib/purecloudplatformclientv2/api/routing_api.rb +239 -9
- data/lib/purecloudplatformclientv2/api/scim_api.rb +364 -20
- data/lib/purecloudplatformclientv2/api/users_api.rb +127 -353
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +81 -8
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +30 -4
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/bu_search_agent_schedules_request.rb +266 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_center_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_conversation.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_cobrowse_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_deletion_protection_query.rb +209 -0
- data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_screen_share_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_social_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_video_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/{create_management_unit_settings.rb → create_management_unit_settings_request.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/create_work_plan.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +27 -1
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_responseset_config_change_response_set.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_logical_interface.rb +105 -1
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +55 -3
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type.rb +29 -1
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_address_verification_details.rb +294 -0
- data/lib/purecloudplatformclientv2/models/location_create_definition.rb +405 -0
- data/lib/purecloudplatformclientv2/models/location_definition.rb +110 -34
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{location_create_update_definition.rb → location_update_definition.rb} +48 -63
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit.rb +1 -1
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{user_external_identifier.rb → management_unit_reference.rb} +10 -46
- data/lib/purecloudplatformclientv2/models/{management_unit_settings.rb → management_unit_settings_request.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/management_unit_settings_response.rb +337 -0
- data/lib/purecloudplatformclientv2/models/manager.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_evaluation.rb +277 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/participant.rb +56 -4
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +56 -4
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/photo.rb +1 -1
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/planning_period_settings.rb +238 -0
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_conversation.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_cobrowse_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_screen_share_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +31 -31
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording.rb +27 -1
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/recording_metadata.rb +27 -1
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +58 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +55 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/role_division_grants.rb +209 -0
- data/lib/purecloudplatformclientv2/models/role_division_pair.rb +238 -0
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{scheduling_settings.rb → scheduling_settings_request.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/scheduling_settings_response.rb +255 -0
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_error.rb +5 -5
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +8 -8
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +2 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +34 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +3 -2
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/selected_columns.rb +228 -0
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +314 -0
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +424 -0
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/shift_trade_settings.rb +27 -1
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +29 -1
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +56 -4
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +357 -1
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/transcription_settings.rb +252 -0
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustee_billing_overview.rb +2 -2
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +32 -31
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/value_wrapper_planning_period_settings.rb +203 -0
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_forecast_modification_interval_offset_value.rb +1 -1
- data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_topic_wfm_move_agent_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/whats_app_integration_request.rb +321 -0
- data/lib/purecloudplatformclientv2/models/work_plan.rb +27 -1
- data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/work_plan_reference.rb +57 -9
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +27 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +48 -12
- data/docs/LocationCreateUpdateDefinition.md +0 -21
|
@@ -14,8 +14,8 @@ title: RuleSetEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/SCIMApi.md
CHANGED
|
@@ -8,7 +8,9 @@ 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
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.
|
|
12
14
|
[**delete_scim_v2_user**](SCIMApi.html#delete_scim_v2_user) | Delete a user
|
|
13
15
|
[**get_scim_group**](SCIMApi.html#get_scim_group) | Get a group
|
|
14
16
|
[**get_scim_groups**](SCIMApi.html#get_scim_groups) | Get a list of groups
|
|
@@ -28,7 +30,9 @@ Method | Description
|
|
|
28
30
|
[**patch_scim_user**](SCIMApi.html#patch_scim_user) | Modify a user
|
|
29
31
|
[**patch_scim_v2_group**](SCIMApi.html#patch_scim_v2_group) | Modify a group
|
|
30
32
|
[**patch_scim_v2_user**](SCIMApi.html#patch_scim_v2_user) | Modify a user
|
|
33
|
+
[**post_scim_groups**](SCIMApi.html#post_scim_groups) | The information used to create a group.
|
|
31
34
|
[**post_scim_users**](SCIMApi.html#post_scim_users) | Create a user
|
|
35
|
+
[**post_scim_v2_groups**](SCIMApi.html#post_scim_v2_groups) | The information used to create a group.
|
|
32
36
|
[**post_scim_v2_users**](SCIMApi.html#post_scim_v2_users) | Create a user
|
|
33
37
|
[**put_scim_group**](SCIMApi.html#put_scim_group) | Replace a group
|
|
34
38
|
[**put_scim_user**](SCIMApi.html#put_scim_user) | Replace a user
|
|
@@ -36,6 +40,74 @@ Method | Description
|
|
|
36
40
|
[**put_scim_v2_user**](SCIMApi.html#put_scim_v2_user) | Replace a user
|
|
37
41
|
{: class="table table-striped"}
|
|
38
42
|
|
|
43
|
+
<a name="delete_scim_group"></a>
|
|
44
|
+
|
|
45
|
+
## delete_scim_group(group_id, opts)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
Delete a group.
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
Wraps DELETE /api/v2/scim/groups/{groupId}
|
|
54
|
+
|
|
55
|
+
Requires ANY permissions:
|
|
56
|
+
|
|
57
|
+
* directory:group:edit
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### Example
|
|
61
|
+
```{"language":"ruby"}
|
|
62
|
+
# load the gem
|
|
63
|
+
require 'purecloudplatformclientv2'
|
|
64
|
+
# setup authorization
|
|
65
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
66
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
67
|
+
environment = "mypurecloud.com"
|
|
68
|
+
|
|
69
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
70
|
+
|
|
71
|
+
PureCloud.configure do |config|
|
|
72
|
+
config.access_token = @authToken
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
api_instance = PureCloud::SCIMApi.new
|
|
76
|
+
|
|
77
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
78
|
+
|
|
79
|
+
opts = {
|
|
80
|
+
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\".
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
begin
|
|
84
|
+
#Delete a group.
|
|
85
|
+
api_instance.delete_scim_group(group_id, opts)
|
|
86
|
+
rescue PureCloud::ApiError => e
|
|
87
|
+
puts "Exception when calling SCIMApi->delete_scim_group: #{e}"
|
|
88
|
+
end
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Parameters
|
|
92
|
+
|
|
93
|
+
Name | Type | Description | Notes
|
|
94
|
+
------------- | ------------- | ------------- | -------------
|
|
95
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
96
|
+
**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] |
|
|
97
|
+
{: class="table table-striped"}
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
### Return type
|
|
101
|
+
|
|
102
|
+
nil (empty response body)
|
|
103
|
+
|
|
104
|
+
### HTTP request headers
|
|
105
|
+
|
|
106
|
+
- **Content-Type**: application/json, application/scim+json
|
|
107
|
+
- **Accept**: application/json, application/scim+json
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
39
111
|
<a name="delete_scim_user"></a>
|
|
40
112
|
|
|
41
113
|
## [**Empty**](Empty.html) delete_scim_user(user_id, opts)
|
|
@@ -105,6 +177,74 @@ Name | Type | Description | Notes
|
|
|
105
177
|
|
|
106
178
|
|
|
107
179
|
|
|
180
|
+
<a name="delete_scim_v2_group"></a>
|
|
181
|
+
|
|
182
|
+
## delete_scim_v2_group(group_id, opts)
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
Delete a group.
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
Wraps DELETE /api/v2/scim/v2/groups/{groupId}
|
|
191
|
+
|
|
192
|
+
Requires ANY permissions:
|
|
193
|
+
|
|
194
|
+
* directory:group:edit
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
```{"language":"ruby"}
|
|
199
|
+
# load the gem
|
|
200
|
+
require 'purecloudplatformclientv2'
|
|
201
|
+
# setup authorization
|
|
202
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
203
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
204
|
+
environment = "mypurecloud.com"
|
|
205
|
+
|
|
206
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
207
|
+
|
|
208
|
+
PureCloud.configure do |config|
|
|
209
|
+
config.access_token = @authToken
|
|
210
|
+
end
|
|
211
|
+
|
|
212
|
+
api_instance = PureCloud::SCIMApi.new
|
|
213
|
+
|
|
214
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
215
|
+
|
|
216
|
+
opts = {
|
|
217
|
+
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\".
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
begin
|
|
221
|
+
#Delete a group.
|
|
222
|
+
api_instance.delete_scim_v2_group(group_id, opts)
|
|
223
|
+
rescue PureCloud::ApiError => e
|
|
224
|
+
puts "Exception when calling SCIMApi->delete_scim_v2_group: #{e}"
|
|
225
|
+
end
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### Parameters
|
|
229
|
+
|
|
230
|
+
Name | Type | Description | Notes
|
|
231
|
+
------------- | ------------- | ------------- | -------------
|
|
232
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
233
|
+
**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] |
|
|
234
|
+
{: class="table table-striped"}
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
### Return type
|
|
238
|
+
|
|
239
|
+
nil (empty response body)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: application/json, application/scim+json
|
|
244
|
+
- **Accept**: application/json, application/scim+json
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
108
248
|
<a name="delete_scim_v2_user"></a>
|
|
109
249
|
|
|
110
250
|
## [**Empty**](Empty.html) delete_scim_v2_user(user_id, opts)
|
|
@@ -482,10 +622,8 @@ Get a user
|
|
|
482
622
|
|
|
483
623
|
Wraps GET /api/v2/scim/users/{userId}
|
|
484
624
|
|
|
485
|
-
Requires
|
|
625
|
+
Requires NO permissions:
|
|
486
626
|
|
|
487
|
-
* directory:user:view
|
|
488
|
-
* directory:user:edit
|
|
489
627
|
|
|
490
628
|
|
|
491
629
|
### Example
|
|
@@ -508,6 +646,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
508
646
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
509
647
|
|
|
510
648
|
opts = {
|
|
649
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
650
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
511
651
|
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.
|
|
512
652
|
}
|
|
513
653
|
|
|
@@ -525,6 +665,8 @@ end
|
|
|
525
665
|
Name | Type | Description | Notes
|
|
526
666
|
------------- | ------------- | ------------- | -------------
|
|
527
667
|
**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 and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, photos, 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:photos, 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 |
|
|
669
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, photos, 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:photos, 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 |
|
|
528
670
|
**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] |
|
|
529
671
|
{: class="table table-striped"}
|
|
530
672
|
|
|
@@ -542,20 +684,18 @@ Name | Type | Description | Notes
|
|
|
542
684
|
|
|
543
685
|
<a name="get_scim_users"></a>
|
|
544
686
|
|
|
545
|
-
## [**ScimUserListResponse**](ScimUserListResponse.html) get_scim_users(
|
|
687
|
+
## [**ScimUserListResponse**](ScimUserListResponse.html) get_scim_users(opts)
|
|
546
688
|
|
|
547
689
|
|
|
548
690
|
|
|
549
691
|
Get a list of users
|
|
550
692
|
|
|
551
|
-
|
|
693
|
+
To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
552
694
|
|
|
553
695
|
Wraps GET /api/v2/scim/users
|
|
554
696
|
|
|
555
|
-
Requires
|
|
697
|
+
Requires NO permissions:
|
|
556
698
|
|
|
557
|
-
* directory:user:view
|
|
558
|
-
* directory:user:edit
|
|
559
699
|
|
|
560
700
|
|
|
561
701
|
### Example
|
|
@@ -575,16 +715,17 @@ end
|
|
|
575
715
|
|
|
576
716
|
api_instance = PureCloud::SCIMApi.new
|
|
577
717
|
|
|
578
|
-
filter = "filter_example" # String | Filters results.
|
|
579
|
-
|
|
580
718
|
opts = {
|
|
581
719
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
582
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
720
|
+
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 and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
722
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
723
|
+
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\".
|
|
583
724
|
}
|
|
584
725
|
|
|
585
726
|
begin
|
|
586
727
|
#Get a list of users
|
|
587
|
-
result = api_instance.get_scim_users(
|
|
728
|
+
result = api_instance.get_scim_users(opts)
|
|
588
729
|
p result
|
|
589
730
|
rescue PureCloud::ApiError => e
|
|
590
731
|
puts "Exception when calling SCIMApi->get_scim_users: #{e}"
|
|
@@ -595,9 +736,11 @@ end
|
|
|
595
736
|
|
|
596
737
|
Name | Type | Description | Notes
|
|
597
738
|
------------- | ------------- | ------------- | -------------
|
|
598
|
-
**filter** | **String**| Filters results. | |
|
|
599
739
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
600
740
|
**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 and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, photos, 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:photos, 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 |
|
|
742
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, photos, 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:photos, 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 |
|
|
743
|
+
**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] |
|
|
601
744
|
{: class="table table-striped"}
|
|
602
745
|
|
|
603
746
|
|
|
@@ -921,10 +1064,8 @@ Get a user
|
|
|
921
1064
|
|
|
922
1065
|
Wraps GET /api/v2/scim/v2/users/{userId}
|
|
923
1066
|
|
|
924
|
-
Requires
|
|
1067
|
+
Requires NO permissions:
|
|
925
1068
|
|
|
926
|
-
* directory:user:view
|
|
927
|
-
* directory:user:edit
|
|
928
1069
|
|
|
929
1070
|
|
|
930
1071
|
### Example
|
|
@@ -947,6 +1088,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
947
1088
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
948
1089
|
|
|
949
1090
|
opts = {
|
|
1091
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1092
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
950
1093
|
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.
|
|
951
1094
|
}
|
|
952
1095
|
|
|
@@ -964,6 +1107,8 @@ end
|
|
|
964
1107
|
Name | Type | Description | Notes
|
|
965
1108
|
------------- | ------------- | ------------- | -------------
|
|
966
1109
|
**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 and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, photos, 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:photos, 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 |
|
|
1111
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, photos, 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:photos, 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 |
|
|
967
1112
|
**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] |
|
|
968
1113
|
{: class="table table-striped"}
|
|
969
1114
|
|
|
@@ -981,20 +1126,18 @@ Name | Type | Description | Notes
|
|
|
981
1126
|
|
|
982
1127
|
<a name="get_scim_v2_users"></a>
|
|
983
1128
|
|
|
984
|
-
## [**ScimUserListResponse**](ScimUserListResponse.html) get_scim_v2_users(
|
|
1129
|
+
## [**ScimUserListResponse**](ScimUserListResponse.html) get_scim_v2_users(opts)
|
|
985
1130
|
|
|
986
1131
|
|
|
987
1132
|
|
|
988
1133
|
Get a list of users
|
|
989
1134
|
|
|
990
|
-
|
|
1135
|
+
To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
991
1136
|
|
|
992
1137
|
Wraps GET /api/v2/scim/v2/users
|
|
993
1138
|
|
|
994
|
-
Requires
|
|
1139
|
+
Requires NO permissions:
|
|
995
1140
|
|
|
996
|
-
* directory:user:view
|
|
997
|
-
* directory:user:edit
|
|
998
1141
|
|
|
999
1142
|
|
|
1000
1143
|
### Example
|
|
@@ -1014,16 +1157,17 @@ end
|
|
|
1014
1157
|
|
|
1015
1158
|
api_instance = PureCloud::SCIMApi.new
|
|
1016
1159
|
|
|
1017
|
-
filter = "filter_example" # String | Filters results.
|
|
1018
|
-
|
|
1019
1160
|
opts = {
|
|
1020
1161
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
1021
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1162
|
+
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 and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1164
|
+
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
1165
|
+
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\".
|
|
1022
1166
|
}
|
|
1023
1167
|
|
|
1024
1168
|
begin
|
|
1025
1169
|
#Get a list of users
|
|
1026
|
-
result = api_instance.get_scim_v2_users(
|
|
1170
|
+
result = api_instance.get_scim_v2_users(opts)
|
|
1027
1171
|
p result
|
|
1028
1172
|
rescue PureCloud::ApiError => e
|
|
1029
1173
|
puts "Exception when calling SCIMApi->get_scim_v2_users: #{e}"
|
|
@@ -1034,9 +1178,11 @@ end
|
|
|
1034
1178
|
|
|
1035
1179
|
Name | Type | Description | Notes
|
|
1036
1180
|
------------- | ------------- | ------------- | -------------
|
|
1037
|
-
**filter** | **String**| Filters results. | |
|
|
1038
1181
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
1039
1182
|
**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 and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, photos, 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:photos, 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 |
|
|
1184
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, photos, 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:photos, 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 |
|
|
1185
|
+
**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] |
|
|
1040
1186
|
{: class="table table-striped"}
|
|
1041
1187
|
|
|
1042
1188
|
|
|
@@ -1341,6 +1487,71 @@ Name | Type | Description | Notes
|
|
|
1341
1487
|
|
|
1342
1488
|
|
|
1343
1489
|
|
|
1490
|
+
<a name="post_scim_groups"></a>
|
|
1491
|
+
|
|
1492
|
+
## [**ScimV2Group**](ScimV2Group.html) post_scim_groups(body)
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
The information used to create a group.
|
|
1497
|
+
|
|
1498
|
+
PureCloud group will be created as \"Official\" group with visibility set \"Public\", and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
|
|
1499
|
+
|
|
1500
|
+
Wraps POST /api/v2/scim/groups
|
|
1501
|
+
|
|
1502
|
+
Requires ANY permissions:
|
|
1503
|
+
|
|
1504
|
+
* directory:group:edit
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
### Example
|
|
1508
|
+
```{"language":"ruby"}
|
|
1509
|
+
# load the gem
|
|
1510
|
+
require 'purecloudplatformclientv2'
|
|
1511
|
+
# setup authorization
|
|
1512
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1513
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1514
|
+
environment = "mypurecloud.com"
|
|
1515
|
+
|
|
1516
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1517
|
+
|
|
1518
|
+
PureCloud.configure do |config|
|
|
1519
|
+
config.access_token = @authToken
|
|
1520
|
+
end
|
|
1521
|
+
|
|
1522
|
+
api_instance = PureCloud::SCIMApi.new
|
|
1523
|
+
|
|
1524
|
+
body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to create a group.
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
begin
|
|
1528
|
+
#The information used to create a group.
|
|
1529
|
+
result = api_instance.post_scim_groups(body)
|
|
1530
|
+
p result
|
|
1531
|
+
rescue PureCloud::ApiError => e
|
|
1532
|
+
puts "Exception when calling SCIMApi->post_scim_groups: #{e}"
|
|
1533
|
+
end
|
|
1534
|
+
```
|
|
1535
|
+
|
|
1536
|
+
### Parameters
|
|
1537
|
+
|
|
1538
|
+
Name | Type | Description | Notes
|
|
1539
|
+
------------- | ------------- | ------------- | -------------
|
|
1540
|
+
**body** | [**ScimV2Group**](ScimV2Group.html)| The information used to create a group. | |
|
|
1541
|
+
{: class="table table-striped"}
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
### Return type
|
|
1545
|
+
|
|
1546
|
+
[**ScimV2Group**](ScimV2Group.html)
|
|
1547
|
+
|
|
1548
|
+
### HTTP request headers
|
|
1549
|
+
|
|
1550
|
+
- **Content-Type**: application/json, application/scim+json
|
|
1551
|
+
- **Accept**: application/json, application/scim+json
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
|
|
1344
1555
|
<a name="post_scim_users"></a>
|
|
1345
1556
|
|
|
1346
1557
|
## [**ScimV2User**](ScimV2User.html) post_scim_users(body)
|
|
@@ -1406,6 +1617,71 @@ Name | Type | Description | Notes
|
|
|
1406
1617
|
|
|
1407
1618
|
|
|
1408
1619
|
|
|
1620
|
+
<a name="post_scim_v2_groups"></a>
|
|
1621
|
+
|
|
1622
|
+
## [**ScimV2Group**](ScimV2Group.html) post_scim_v2_groups(body)
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
The information used to create a group.
|
|
1627
|
+
|
|
1628
|
+
PureCloud group will be created as \"Official\" group with visibility set \"Public\", and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
|
|
1629
|
+
|
|
1630
|
+
Wraps POST /api/v2/scim/v2/groups
|
|
1631
|
+
|
|
1632
|
+
Requires ANY permissions:
|
|
1633
|
+
|
|
1634
|
+
* directory:group:edit
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
### Example
|
|
1638
|
+
```{"language":"ruby"}
|
|
1639
|
+
# load the gem
|
|
1640
|
+
require 'purecloudplatformclientv2'
|
|
1641
|
+
# setup authorization
|
|
1642
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1643
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1644
|
+
environment = "mypurecloud.com"
|
|
1645
|
+
|
|
1646
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1647
|
+
|
|
1648
|
+
PureCloud.configure do |config|
|
|
1649
|
+
config.access_token = @authToken
|
|
1650
|
+
end
|
|
1651
|
+
|
|
1652
|
+
api_instance = PureCloud::SCIMApi.new
|
|
1653
|
+
|
|
1654
|
+
body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to create a group.
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
begin
|
|
1658
|
+
#The information used to create a group.
|
|
1659
|
+
result = api_instance.post_scim_v2_groups(body)
|
|
1660
|
+
p result
|
|
1661
|
+
rescue PureCloud::ApiError => e
|
|
1662
|
+
puts "Exception when calling SCIMApi->post_scim_v2_groups: #{e}"
|
|
1663
|
+
end
|
|
1664
|
+
```
|
|
1665
|
+
|
|
1666
|
+
### Parameters
|
|
1667
|
+
|
|
1668
|
+
Name | Type | Description | Notes
|
|
1669
|
+
------------- | ------------- | ------------- | -------------
|
|
1670
|
+
**body** | [**ScimV2Group**](ScimV2Group.html)| The information used to create a group. | |
|
|
1671
|
+
{: class="table table-striped"}
|
|
1672
|
+
|
|
1673
|
+
|
|
1674
|
+
### Return type
|
|
1675
|
+
|
|
1676
|
+
[**ScimV2Group**](ScimV2Group.html)
|
|
1677
|
+
|
|
1678
|
+
### HTTP request headers
|
|
1679
|
+
|
|
1680
|
+
- **Content-Type**: application/json, application/scim+json
|
|
1681
|
+
- **Accept**: application/json, application/scim+json
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
|
|
1409
1685
|
<a name="post_scim_v2_users"></a>
|
|
1410
1686
|
|
|
1411
1687
|
## [**ScimV2User**](ScimV2User.html) post_scim_v2_users(body)
|