purecloudplatformclientv2 64.0.0 → 68.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/AnalyticsEvaluation.md +2 -0
- data/docs/ArchitectApi.md +18 -85
- data/docs/ArchitectDependencyTrackingBuildNotificationClient.md +14 -0
- data/docs/ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification.md +1 -0
- data/docs/ArchitectFlowNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectFlowNotificationClient.md +14 -0
- data/docs/ArchitectFlowOutcomeNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectFlowOutcomeNotificationClient.md +14 -0
- data/docs/ArchitectPromptNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectPromptNotificationClient.md +14 -0
- data/docs/AsyncConversationQuery.md +1 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +140 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversation.md +1 -0
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- 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/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- 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/ConversationCallEventTopicCallConversation.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/CreateWorkPlan.md +11 -0
- data/docs/CreateWorkPlanActivity.md +2 -0
- data/docs/CreateWorkPlanShift.md +7 -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/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/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/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationAggregationQuery.md +1 -0
- 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/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/HomerRecord.md +63 -0
- 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/IpAddressRange.md +15 -0
- data/docs/IpAddressRangeListing.md +13 -0
- 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/LocationCreateUpdateDefinition.md +6 -6
- data/docs/LocationDefinition.md +12 -9
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +2 -2
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- 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/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/QualityAuditPage.md +1 -1
- data/docs/QueueConversationCallEventTopicCallConversation.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/Recording.md +1 -0
- 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 +1 -0
- data/docs/ReportingExportJobResponse.md +1 -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/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +88 -96
- data/docs/SIPSearchPublicRequest.md +22 -0
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchedulingSettings.md +1 -0
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +7 -7
- data/docs/ScimConfigResourceTypeSchemaExtension.md +2 -2
- data/docs/ScimConfigResourceTypesListResponse.md +2 -2
- data/docs/ScimGroupListResponse.md +2 -2
- data/docs/ScimMetadata.md +2 -2
- data/docs/ScimPhoneNumber.md +1 -1
- data/docs/ScimServiceProviderConfig.md +9 -9
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +6 -6
- data/docs/ScimServiceProviderConfigBulkFeature.md +3 -3
- data/docs/ScimServiceProviderConfigFilterFeature.md +2 -2
- data/docs/ScimServiceProviderConfigSimpleFeature.md +1 -1
- data/docs/ScimUserListResponse.md +2 -2
- data/docs/ScimV2CreateUser.md +9 -9
- data/docs/ScimV2Group.md +3 -3
- data/docs/ScimV2GroupReference.md +2 -2
- data/docs/ScimV2MemberReference.md +2 -2
- data/docs/ScimV2PatchOperation.md +2 -2
- data/docs/ScimV2PatchRequest.md +2 -2
- data/docs/ScimV2User.md +10 -10
- 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/ShareEntityListing.md +1 -1
- data/docs/SignedUrlResponse.md +16 -0
- data/docs/SipDownloadResponse.md +14 -0
- data/docs/SipSearchResult.md +20 -0
- data/docs/Site.md +1 -0
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddressEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SuggestApi.md +2 -2
- 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/TelephonyApi.md +223 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeOffRequestLookup.md +13 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- 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/TrusteeBillingOverview.md +1 -0
- 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/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserDetailsQuery.md +2 -2
- 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 +140 -0
- data/docs/UtilitiesApi.md +59 -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/WorkPlan.md +11 -0
- data/docs/WorkPlanActivity.md +2 -0
- data/docs/WorkPlanListItemResponse.md +11 -0
- data/docs/WorkPlanShift.md +7 -0
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +16 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -81
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/notifications_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +134 -84
- data/lib/purecloudplatformclientv2/api/telephony_api.rb +270 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/utilities_api.rb +55 -0
- 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_evaluation.rb +53 -1
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_dependency_tracking_build_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_prompt_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_prompt_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/async_conversation_query.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/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation.rb +27 -1
- 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/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- 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/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- 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_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_aggregation_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_conversation.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/create_work_plan.rb +301 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_activity.rb +56 -4
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +211 -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/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_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/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_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_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_predicate.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_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_division_view.rb +2 -2
- 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/homer_record.rb +1501 -0
- 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/ip_address_range.rb +265 -0
- data/lib/purecloudplatformclientv2/models/ip_address_range_listing.rb +203 -0
- 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_update_definition.rb +56 -51
- data/lib/purecloudplatformclientv2/models/location_definition.rb +110 -34
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/manager.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- 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/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/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_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- 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 +32 -6
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +29 -3
- 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 +30 -4
- 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 +7 -7
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +9 -9
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +7 -7
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +9 -8
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +3 -3
- 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_patch_operation.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +2 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +10 -9
- 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/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/signed_url_response.rb +279 -0
- data/lib/purecloudplatformclientv2/models/sip_download_response.rb +228 -0
- data/lib/purecloudplatformclientv2/models/{data_table_import_job.rb → sip_search_public_request.rb} +57 -133
- data/lib/purecloudplatformclientv2/models/sip_search_result.rb +386 -0
- data/lib/purecloudplatformclientv2/models/site.rb +26 -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_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/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/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 +27 -1
- 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/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +52 -51
- 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/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/whats_app_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/work_plan.rb +301 -1
- data/lib/purecloudplatformclientv2/models/work_plan_activity.rb +53 -1
- data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +301 -1
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +211 -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 +34 -4
- data/docs/DataTableImportJob.md +0 -24
data/docs/PhoneEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: PhoneEntityListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: PhoneMetaBaseEntityListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: PhysicalInterfaceEntityListing
|
|
|
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
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: PlanningPeriodSettings
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::PlanningPeriodSettings
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **week_count** | **Integer** | Planning period length in weeks | |
|
|
11
|
+
| **start_date** | **DateTime** | Start date of the planning period. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/PolicyEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: PolicyEntityListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: PromptAssetEntityListing
|
|
|
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/PromptEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: PromptEntityListing
|
|
|
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/QualityAuditPage.md
CHANGED
|
@@ -14,8 +14,8 @@ title: QualityAuditPage
|
|
|
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
|
|
|
@@ -12,6 +12,7 @@ title: QueueConversationCallEventTopicCallConversation
|
|
|
12
12
|
| **participants** | [**Array<QueueConversationCallEventTopicCallMediaParticipant>**](QueueConversationCallEventTopicCallMediaParticipant.html) | | [optional] |
|
|
13
13
|
| **other_media_uris** | **Array<String>** | | [optional] |
|
|
14
14
|
| **recording_state** | **String** | | [optional] |
|
|
15
|
+
| **max_participants** | **Integer** | | [optional] |
|
|
15
16
|
{: class="table table-striped"}
|
|
16
17
|
|
|
17
18
|
|
data/docs/QueueEntityListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: QueueEntityListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: QueueMemberEntityListing
|
|
|
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/RecipientListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: RecipientListing
|
|
|
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/Recording.md
CHANGED
|
@@ -26,6 +26,7 @@ title: Recording
|
|
|
26
26
|
| **archive_date** | **DateTime** | The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
27
27
|
| **archive_medium** | **String** | The type of archive medium used. Example: CloudArchive | [optional] |
|
|
28
28
|
| **delete_date** | **DateTime** | The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
29
|
+
| **export_date** | **DateTime** | The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
29
30
|
| **output_duration_ms** | **Integer** | Duration of transcoded media in milliseconds | [optional] |
|
|
30
31
|
| **output_size_in_bytes** | **Integer** | Size of transcoded media in bytes. 0 if there is no transcoded media. | [optional] |
|
|
31
32
|
| **max_allowed_restorations_for_org** | **Integer** | How many archive restorations the organization is allowed to have. | [optional] |
|
|
@@ -14,8 +14,8 @@ title: RecordingJobEntityListing
|
|
|
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/RecordingJobsQuery.md
CHANGED
|
@@ -8,7 +8,7 @@ title: RecordingJobsQuery
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **action** | **String** | Operation to perform bulk task | |
|
|
11
|
-
| **action_date** | **DateTime** | The date when the action will be performed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
11
|
+
| **action_date** | **DateTime** | The date when the action will be performed. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
12
12
|
| **integration_id** | **String** | IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is for EXPORT only | [optional] |
|
|
13
13
|
| **include_screen_recordings** | **BOOLEAN** | Include Screen recordings for export action, default value = true | [optional] |
|
|
14
14
|
| **conversation_query** | [**AsyncConversationQuery**](AsyncConversationQuery.html) | Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query. | |
|
data/docs/RecordingMetadata.md
CHANGED
|
@@ -20,6 +20,7 @@ title: RecordingMetadata
|
|
|
20
20
|
| **archive_date** | **DateTime** | The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
21
21
|
| **archive_medium** | **String** | The type of archive medium used. Example: CloudArchive | [optional] |
|
|
22
22
|
| **delete_date** | **DateTime** | The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
23
|
+
| **export_date** | **DateTime** | The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
23
24
|
| **max_allowed_restorations_for_org** | **Integer** | How many archive restorations the organization is allowed to have. | [optional] |
|
|
24
25
|
| **remaining_restorations_allowed_for_org** | **Integer** | The remaining archive restorations the organization has. | [optional] |
|
|
25
26
|
| **session_id** | **String** | The session id represents an external resource id, such as email, call, chat, etc | [optional] |
|
data/docs/RelationshipListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: RelationshipListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: ReportMetaDataEntityListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: ReportRunEntryEntityDomainListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: ReportScheduleEntityListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: ReportingExportJobListing
|
|
|
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
|
|
|
@@ -17,6 +17,7 @@ title: ReportingExportJobRequest
|
|
|
17
17
|
| **read** | **BOOLEAN** | Indicates if the request has been marked as read | [optional] |
|
|
18
18
|
| **locale** | **String** | The locale use for localization of the exported data, i.e. en-us, es-mx | |
|
|
19
19
|
| **has_format_durations** | **BOOLEAN** | Indicates if durations are formatted in hh:mm:ss format instead of ms | [optional] |
|
|
20
|
+
| **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
|
|
20
21
|
{: class="table table-striped"}
|
|
21
22
|
|
|
22
23
|
|
|
@@ -24,6 +24,7 @@ title: ReportingExportJobResponse
|
|
|
24
24
|
| **locale** | **String** | The locale use for localization of the exported data, i.e. en-us, es-mx | |
|
|
25
25
|
| **percentage_complete** | **Float** | The percentage of the job that has completed processing | |
|
|
26
26
|
| **has_format_durations** | **BOOLEAN** | Indicates if durations are formatted in hh:mm:ss format instead of ms | [optional] |
|
|
27
|
+
| **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
|
|
27
28
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
28
29
|
{: class="table table-striped"}
|
|
29
30
|
|
data/docs/ResponseEntityList.md
CHANGED
|
@@ -14,8 +14,8 @@ title: ResponseEntityList
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: ResponseEntityListing
|
|
|
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
|
|
|
@@ -14,8 +14,8 @@ title: ResponseSetEntityListing
|
|
|
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
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RoleDivisionGrants
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RoleDivisionGrants
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **grants** | [**Array<RoleDivisionPair>**](RoleDivisionPair.html) | A list containing pairs of role and division IDs | |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RoleDivisionPair
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RoleDivisionPair
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **role_id** | **String** | The ID of the role | |
|
|
11
|
+
| **division_id** | **String** | The ID of the division | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -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
|
@@ -12,16 +12,16 @@ Method | Description
|
|
|
12
12
|
[**delete_scim_v2_user**](SCIMApi.html#delete_scim_v2_user) | Delete a user
|
|
13
13
|
[**get_scim_group**](SCIMApi.html#get_scim_group) | Get a group
|
|
14
14
|
[**get_scim_groups**](SCIMApi.html#get_scim_groups) | Get a list of groups
|
|
15
|
-
[**get_scim_resourcetype**](SCIMApi.html#get_scim_resourcetype) | Get
|
|
16
|
-
[**get_scim_resourcetypes**](SCIMApi.html#get_scim_resourcetypes) | Get
|
|
17
|
-
[**get_scim_serviceproviderconfig**](SCIMApi.html#get_scim_serviceproviderconfig) | Get
|
|
15
|
+
[**get_scim_resourcetype**](SCIMApi.html#get_scim_resourcetype) | Get a resource type
|
|
16
|
+
[**get_scim_resourcetypes**](SCIMApi.html#get_scim_resourcetypes) | Get a list of resource types
|
|
17
|
+
[**get_scim_serviceproviderconfig**](SCIMApi.html#get_scim_serviceproviderconfig) | Get a service provider's configuration
|
|
18
18
|
[**get_scim_user**](SCIMApi.html#get_scim_user) | Get a user
|
|
19
19
|
[**get_scim_users**](SCIMApi.html#get_scim_users) | Get a list of users
|
|
20
20
|
[**get_scim_v2_group**](SCIMApi.html#get_scim_v2_group) | Get a group
|
|
21
21
|
[**get_scim_v2_groups**](SCIMApi.html#get_scim_v2_groups) | Get a list of groups
|
|
22
|
-
[**get_scim_v2_resourcetype**](SCIMApi.html#get_scim_v2_resourcetype) | Get
|
|
23
|
-
[**get_scim_v2_resourcetypes**](SCIMApi.html#get_scim_v2_resourcetypes) | Get
|
|
24
|
-
[**get_scim_v2_serviceproviderconfig**](SCIMApi.html#get_scim_v2_serviceproviderconfig) | Get
|
|
22
|
+
[**get_scim_v2_resourcetype**](SCIMApi.html#get_scim_v2_resourcetype) | Get a resource type
|
|
23
|
+
[**get_scim_v2_resourcetypes**](SCIMApi.html#get_scim_v2_resourcetypes) | Get a list of resource types
|
|
24
|
+
[**get_scim_v2_serviceproviderconfig**](SCIMApi.html#get_scim_v2_serviceproviderconfig) | Get a service provider's configuration
|
|
25
25
|
[**get_scim_v2_user**](SCIMApi.html#get_scim_v2_user) | Get a user
|
|
26
26
|
[**get_scim_v2_users**](SCIMApi.html#get_scim_v2_users) | Get a list of users
|
|
27
27
|
[**patch_scim_group**](SCIMApi.html#patch_scim_group) | Modify a group
|
|
@@ -73,7 +73,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
73
73
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
74
74
|
|
|
75
75
|
opts = {
|
|
76
|
-
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
76
|
+
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
77
77
|
}
|
|
78
78
|
|
|
79
79
|
begin
|
|
@@ -90,7 +90,7 @@ end
|
|
|
90
90
|
Name | Type | Description | Notes
|
|
91
91
|
------------- | ------------- | ------------- | -------------
|
|
92
92
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
93
|
-
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
93
|
+
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
94
94
|
{: class="table table-striped"}
|
|
95
95
|
|
|
96
96
|
|
|
@@ -142,7 +142,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
142
142
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
143
143
|
|
|
144
144
|
opts = {
|
|
145
|
-
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
145
|
+
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
146
146
|
}
|
|
147
147
|
|
|
148
148
|
begin
|
|
@@ -159,7 +159,7 @@ end
|
|
|
159
159
|
Name | Type | Description | Notes
|
|
160
160
|
------------- | ------------- | ------------- | -------------
|
|
161
161
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
162
|
-
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
162
|
+
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
163
163
|
{: class="table table-striped"}
|
|
164
164
|
|
|
165
165
|
|
|
@@ -279,7 +279,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
279
279
|
|
|
280
280
|
opts = {
|
|
281
281
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
282
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
282
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
283
283
|
filter: "displayName eq groupName" # String | Filters results.
|
|
284
284
|
}
|
|
285
285
|
|
|
@@ -297,7 +297,7 @@ end
|
|
|
297
297
|
Name | Type | Description | Notes
|
|
298
298
|
------------- | ------------- | ------------- | -------------
|
|
299
299
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
300
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults
|
|
300
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
301
301
|
**filter** | **String**| Filters results. | [optional] |
|
|
302
302
|
{: class="table table-striped"}
|
|
303
303
|
|
|
@@ -319,7 +319,7 @@ Name | Type | Description | Notes
|
|
|
319
319
|
|
|
320
320
|
|
|
321
321
|
|
|
322
|
-
Get
|
|
322
|
+
Get a resource type
|
|
323
323
|
|
|
324
324
|
|
|
325
325
|
|
|
@@ -336,11 +336,11 @@ require 'purecloudplatformclientv2'
|
|
|
336
336
|
|
|
337
337
|
api_instance = PureCloud::SCIMApi.new
|
|
338
338
|
|
|
339
|
-
resource_type = "resource_type_example" # String | The
|
|
339
|
+
resource_type = "resource_type_example" # String | The type of resource. Returned with GET /api/v2/scim/resourcetypes.
|
|
340
340
|
|
|
341
341
|
|
|
342
342
|
begin
|
|
343
|
-
#Get
|
|
343
|
+
#Get a resource type
|
|
344
344
|
result = api_instance.get_scim_resourcetype(resource_type)
|
|
345
345
|
p result
|
|
346
346
|
rescue PureCloud::ApiError => e
|
|
@@ -352,7 +352,7 @@ end
|
|
|
352
352
|
|
|
353
353
|
Name | Type | Description | Notes
|
|
354
354
|
------------- | ------------- | ------------- | -------------
|
|
355
|
-
**resource_type** | **String**| The
|
|
355
|
+
**resource_type** | **String**| The type of resource. Returned with GET /api/v2/scim/resourcetypes. | <br />**Values**: User, Group, ServiceProviderConfig, ResourceType |
|
|
356
356
|
{: class="table table-striped"}
|
|
357
357
|
|
|
358
358
|
|
|
@@ -369,11 +369,11 @@ Name | Type | Description | Notes
|
|
|
369
369
|
|
|
370
370
|
<a name="get_scim_resourcetypes"></a>
|
|
371
371
|
|
|
372
|
-
## [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html) get_scim_resourcetypes
|
|
372
|
+
## [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html) get_scim_resourcetypes
|
|
373
373
|
|
|
374
374
|
|
|
375
375
|
|
|
376
|
-
Get
|
|
376
|
+
Get a list of resource types
|
|
377
377
|
|
|
378
378
|
|
|
379
379
|
|
|
@@ -390,13 +390,9 @@ require 'purecloudplatformclientv2'
|
|
|
390
390
|
|
|
391
391
|
api_instance = PureCloud::SCIMApi.new
|
|
392
392
|
|
|
393
|
-
opts = {
|
|
394
|
-
filter: "displayName eq groupName" # String | Filtered results are invalid and will result in a 403 (Unauthorized) return.
|
|
395
|
-
}
|
|
396
|
-
|
|
397
393
|
begin
|
|
398
|
-
#Get
|
|
399
|
-
result = api_instance.get_scim_resourcetypes
|
|
394
|
+
#Get a list of resource types
|
|
395
|
+
result = api_instance.get_scim_resourcetypes
|
|
400
396
|
p result
|
|
401
397
|
rescue PureCloud::ApiError => e
|
|
402
398
|
puts "Exception when calling SCIMApi->get_scim_resourcetypes: #{e}"
|
|
@@ -404,10 +400,7 @@ end
|
|
|
404
400
|
```
|
|
405
401
|
|
|
406
402
|
### Parameters
|
|
407
|
-
|
|
408
|
-
Name | Type | Description | Notes
|
|
409
|
-
------------- | ------------- | ------------- | -------------
|
|
410
|
-
**filter** | **String**| Filtered results are invalid and will result in a 403 (Unauthorized) return. | [optional] |
|
|
403
|
+
This endpoint does not need any parameter.
|
|
411
404
|
{: class="table table-striped"}
|
|
412
405
|
|
|
413
406
|
|
|
@@ -428,7 +421,7 @@ Name | Type | Description | Notes
|
|
|
428
421
|
|
|
429
422
|
|
|
430
423
|
|
|
431
|
-
Get
|
|
424
|
+
Get a service provider's configuration
|
|
432
425
|
|
|
433
426
|
|
|
434
427
|
|
|
@@ -446,11 +439,11 @@ require 'purecloudplatformclientv2'
|
|
|
446
439
|
api_instance = PureCloud::SCIMApi.new
|
|
447
440
|
|
|
448
441
|
opts = {
|
|
449
|
-
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/
|
|
442
|
+
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/serviceproviderconfig. 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.
|
|
450
443
|
}
|
|
451
444
|
|
|
452
445
|
begin
|
|
453
|
-
#Get
|
|
446
|
+
#Get a service provider's configuration
|
|
454
447
|
result = api_instance.get_scim_serviceproviderconfig(opts)
|
|
455
448
|
p result
|
|
456
449
|
rescue PureCloud::ApiError => e
|
|
@@ -462,7 +455,7 @@ end
|
|
|
462
455
|
|
|
463
456
|
Name | Type | Description | Notes
|
|
464
457
|
------------- | ------------- | ------------- | -------------
|
|
465
|
-
**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/
|
|
458
|
+
**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/serviceproviderconfig. 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] |
|
|
466
459
|
{: class="table table-striped"}
|
|
467
460
|
|
|
468
461
|
|
|
@@ -489,10 +482,8 @@ Get a user
|
|
|
489
482
|
|
|
490
483
|
Wraps GET /api/v2/scim/users/{userId}
|
|
491
484
|
|
|
492
|
-
Requires
|
|
485
|
+
Requires NO permissions:
|
|
493
486
|
|
|
494
|
-
* directory:user:view
|
|
495
|
-
* directory:user:edit
|
|
496
487
|
|
|
497
488
|
|
|
498
489
|
### Example
|
|
@@ -515,6 +506,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
515
506
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
516
507
|
|
|
517
508
|
opts = {
|
|
509
|
+
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.
|
|
510
|
+
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.
|
|
518
511
|
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.
|
|
519
512
|
}
|
|
520
513
|
|
|
@@ -532,6 +525,8 @@ end
|
|
|
532
525
|
Name | Type | Description | Notes
|
|
533
526
|
------------- | ------------- | ------------- | -------------
|
|
534
527
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
528
|
+
**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 |
|
|
529
|
+
**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 |
|
|
535
530
|
**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] |
|
|
536
531
|
{: class="table table-striped"}
|
|
537
532
|
|
|
@@ -549,20 +544,18 @@ Name | Type | Description | Notes
|
|
|
549
544
|
|
|
550
545
|
<a name="get_scim_users"></a>
|
|
551
546
|
|
|
552
|
-
## [**ScimUserListResponse**](ScimUserListResponse.html) get_scim_users(
|
|
547
|
+
## [**ScimUserListResponse**](ScimUserListResponse.html) get_scim_users(opts)
|
|
553
548
|
|
|
554
549
|
|
|
555
550
|
|
|
556
551
|
Get a list of users
|
|
557
552
|
|
|
558
|
-
|
|
553
|
+
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\".
|
|
559
554
|
|
|
560
555
|
Wraps GET /api/v2/scim/users
|
|
561
556
|
|
|
562
|
-
Requires
|
|
557
|
+
Requires NO permissions:
|
|
563
558
|
|
|
564
|
-
* directory:user:view
|
|
565
|
-
* directory:user:edit
|
|
566
559
|
|
|
567
560
|
|
|
568
561
|
### Example
|
|
@@ -582,16 +575,17 @@ end
|
|
|
582
575
|
|
|
583
576
|
api_instance = PureCloud::SCIMApi.new
|
|
584
577
|
|
|
585
|
-
filter = "filter_example" # String | Filters results.
|
|
586
|
-
|
|
587
578
|
opts = {
|
|
588
579
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
589
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
580
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
581
|
+
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.
|
|
582
|
+
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.
|
|
583
|
+
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\".
|
|
590
584
|
}
|
|
591
585
|
|
|
592
586
|
begin
|
|
593
587
|
#Get a list of users
|
|
594
|
-
result = api_instance.get_scim_users(
|
|
588
|
+
result = api_instance.get_scim_users(opts)
|
|
595
589
|
p result
|
|
596
590
|
rescue PureCloud::ApiError => e
|
|
597
591
|
puts "Exception when calling SCIMApi->get_scim_users: #{e}"
|
|
@@ -602,9 +596,11 @@ end
|
|
|
602
596
|
|
|
603
597
|
Name | Type | Description | Notes
|
|
604
598
|
------------- | ------------- | ------------- | -------------
|
|
605
|
-
**filter** | **String**| Filters results. | |
|
|
606
599
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
607
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults
|
|
600
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
601
|
+
**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 |
|
|
602
|
+
**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 |
|
|
603
|
+
**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] |
|
|
608
604
|
{: class="table table-striped"}
|
|
609
605
|
|
|
610
606
|
|
|
@@ -726,7 +722,7 @@ filter = "displayName eq groupName" # String | Filters results.
|
|
|
726
722
|
|
|
727
723
|
opts = {
|
|
728
724
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
729
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
725
|
+
count: 25 # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
730
726
|
}
|
|
731
727
|
|
|
732
728
|
begin
|
|
@@ -744,7 +740,7 @@ Name | Type | Description | Notes
|
|
|
744
740
|
------------- | ------------- | ------------- | -------------
|
|
745
741
|
**filter** | **String**| Filters results. | |
|
|
746
742
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
747
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults
|
|
743
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
748
744
|
{: class="table table-striped"}
|
|
749
745
|
|
|
750
746
|
|
|
@@ -765,7 +761,7 @@ Name | Type | Description | Notes
|
|
|
765
761
|
|
|
766
762
|
|
|
767
763
|
|
|
768
|
-
Get
|
|
764
|
+
Get a resource type
|
|
769
765
|
|
|
770
766
|
|
|
771
767
|
|
|
@@ -782,11 +778,11 @@ require 'purecloudplatformclientv2'
|
|
|
782
778
|
|
|
783
779
|
api_instance = PureCloud::SCIMApi.new
|
|
784
780
|
|
|
785
|
-
resource_type = "resource_type_example" # String | The
|
|
781
|
+
resource_type = "resource_type_example" # String | The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.
|
|
786
782
|
|
|
787
783
|
|
|
788
784
|
begin
|
|
789
|
-
#Get
|
|
785
|
+
#Get a resource type
|
|
790
786
|
result = api_instance.get_scim_v2_resourcetype(resource_type)
|
|
791
787
|
p result
|
|
792
788
|
rescue PureCloud::ApiError => e
|
|
@@ -798,7 +794,7 @@ end
|
|
|
798
794
|
|
|
799
795
|
Name | Type | Description | Notes
|
|
800
796
|
------------- | ------------- | ------------- | -------------
|
|
801
|
-
**resource_type** | **String**| The
|
|
797
|
+
**resource_type** | **String**| The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. | <br />**Values**: User, Group, ServiceProviderConfig, ResourceType |
|
|
802
798
|
{: class="table table-striped"}
|
|
803
799
|
|
|
804
800
|
|
|
@@ -815,11 +811,11 @@ Name | Type | Description | Notes
|
|
|
815
811
|
|
|
816
812
|
<a name="get_scim_v2_resourcetypes"></a>
|
|
817
813
|
|
|
818
|
-
## [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html) get_scim_v2_resourcetypes
|
|
814
|
+
## [**ScimConfigResourceTypesListResponse**](ScimConfigResourceTypesListResponse.html) get_scim_v2_resourcetypes
|
|
819
815
|
|
|
820
816
|
|
|
821
817
|
|
|
822
|
-
Get
|
|
818
|
+
Get a list of resource types
|
|
823
819
|
|
|
824
820
|
|
|
825
821
|
|
|
@@ -836,13 +832,9 @@ require 'purecloudplatformclientv2'
|
|
|
836
832
|
|
|
837
833
|
api_instance = PureCloud::SCIMApi.new
|
|
838
834
|
|
|
839
|
-
opts = {
|
|
840
|
-
filter: "displayName eq groupName" # String | Filtered results are invalid and will result in a 403 (Unauthorized) return.
|
|
841
|
-
}
|
|
842
|
-
|
|
843
835
|
begin
|
|
844
|
-
#Get
|
|
845
|
-
result = api_instance.get_scim_v2_resourcetypes
|
|
836
|
+
#Get a list of resource types
|
|
837
|
+
result = api_instance.get_scim_v2_resourcetypes
|
|
846
838
|
p result
|
|
847
839
|
rescue PureCloud::ApiError => e
|
|
848
840
|
puts "Exception when calling SCIMApi->get_scim_v2_resourcetypes: #{e}"
|
|
@@ -850,10 +842,7 @@ end
|
|
|
850
842
|
```
|
|
851
843
|
|
|
852
844
|
### Parameters
|
|
853
|
-
|
|
854
|
-
Name | Type | Description | Notes
|
|
855
|
-
------------- | ------------- | ------------- | -------------
|
|
856
|
-
**filter** | **String**| Filtered results are invalid and will result in a 403 (Unauthorized) return. | [optional] |
|
|
845
|
+
This endpoint does not need any parameter.
|
|
857
846
|
{: class="table table-striped"}
|
|
858
847
|
|
|
859
848
|
|
|
@@ -874,7 +863,7 @@ Name | Type | Description | Notes
|
|
|
874
863
|
|
|
875
864
|
|
|
876
865
|
|
|
877
|
-
Get
|
|
866
|
+
Get a service provider's configuration
|
|
878
867
|
|
|
879
868
|
|
|
880
869
|
|
|
@@ -896,7 +885,7 @@ opts = {
|
|
|
896
885
|
}
|
|
897
886
|
|
|
898
887
|
begin
|
|
899
|
-
#Get
|
|
888
|
+
#Get a service provider's configuration
|
|
900
889
|
result = api_instance.get_scim_v2_serviceproviderconfig(opts)
|
|
901
890
|
p result
|
|
902
891
|
rescue PureCloud::ApiError => e
|
|
@@ -935,10 +924,8 @@ Get a user
|
|
|
935
924
|
|
|
936
925
|
Wraps GET /api/v2/scim/v2/users/{userId}
|
|
937
926
|
|
|
938
|
-
Requires
|
|
927
|
+
Requires NO permissions:
|
|
939
928
|
|
|
940
|
-
* directory:user:view
|
|
941
|
-
* directory:user:edit
|
|
942
929
|
|
|
943
930
|
|
|
944
931
|
### Example
|
|
@@ -961,6 +948,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
961
948
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
962
949
|
|
|
963
950
|
opts = {
|
|
951
|
+
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.
|
|
952
|
+
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.
|
|
964
953
|
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.
|
|
965
954
|
}
|
|
966
955
|
|
|
@@ -978,6 +967,8 @@ end
|
|
|
978
967
|
Name | Type | Description | Notes
|
|
979
968
|
------------- | ------------- | ------------- | -------------
|
|
980
969
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
970
|
+
**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 |
|
|
971
|
+
**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 |
|
|
981
972
|
**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] |
|
|
982
973
|
{: class="table table-striped"}
|
|
983
974
|
|
|
@@ -995,20 +986,18 @@ Name | Type | Description | Notes
|
|
|
995
986
|
|
|
996
987
|
<a name="get_scim_v2_users"></a>
|
|
997
988
|
|
|
998
|
-
## [**ScimUserListResponse**](ScimUserListResponse.html) get_scim_v2_users(
|
|
989
|
+
## [**ScimUserListResponse**](ScimUserListResponse.html) get_scim_v2_users(opts)
|
|
999
990
|
|
|
1000
991
|
|
|
1001
992
|
|
|
1002
993
|
Get a list of users
|
|
1003
994
|
|
|
1004
|
-
|
|
995
|
+
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\".
|
|
1005
996
|
|
|
1006
997
|
Wraps GET /api/v2/scim/v2/users
|
|
1007
998
|
|
|
1008
|
-
Requires
|
|
999
|
+
Requires NO permissions:
|
|
1009
1000
|
|
|
1010
|
-
* directory:user:view
|
|
1011
|
-
* directory:user:edit
|
|
1012
1001
|
|
|
1013
1002
|
|
|
1014
1003
|
### Example
|
|
@@ -1028,16 +1017,17 @@ end
|
|
|
1028
1017
|
|
|
1029
1018
|
api_instance = PureCloud::SCIMApi.new
|
|
1030
1019
|
|
|
1031
|
-
filter = "filter_example" # String | Filters results.
|
|
1032
|
-
|
|
1033
1020
|
opts = {
|
|
1034
1021
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
1035
|
-
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
1022
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1023
|
+
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.
|
|
1024
|
+
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.
|
|
1025
|
+
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\".
|
|
1036
1026
|
}
|
|
1037
1027
|
|
|
1038
1028
|
begin
|
|
1039
1029
|
#Get a list of users
|
|
1040
|
-
result = api_instance.get_scim_v2_users(
|
|
1030
|
+
result = api_instance.get_scim_v2_users(opts)
|
|
1041
1031
|
p result
|
|
1042
1032
|
rescue PureCloud::ApiError => e
|
|
1043
1033
|
puts "Exception when calling SCIMApi->get_scim_v2_users: #{e}"
|
|
@@ -1048,9 +1038,11 @@ end
|
|
|
1048
1038
|
|
|
1049
1039
|
Name | Type | Description | Notes
|
|
1050
1040
|
------------- | ------------- | ------------- | -------------
|
|
1051
|
-
**filter** | **String**| Filters results. | |
|
|
1052
1041
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
1053
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults
|
|
1042
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
1043
|
+
**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 |
|
|
1044
|
+
**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 |
|
|
1045
|
+
**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] |
|
|
1054
1046
|
{: class="table table-striped"}
|
|
1055
1047
|
|
|
1056
1048
|
|
|
@@ -1104,7 +1096,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
|
|
|
1104
1096
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | The information used to modify a group.
|
|
1105
1097
|
|
|
1106
1098
|
opts = {
|
|
1107
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1099
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1108
1100
|
}
|
|
1109
1101
|
|
|
1110
1102
|
begin
|
|
@@ -1122,7 +1114,7 @@ Name | Type | Description | Notes
|
|
|
1122
1114
|
------------- | ------------- | ------------- | -------------
|
|
1123
1115
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
|
|
1124
1116
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| The information used to modify a group. | |
|
|
1125
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1117
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1126
1118
|
{: class="table table-striped"}
|
|
1127
1119
|
|
|
1128
1120
|
|
|
@@ -1177,7 +1169,7 @@ user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/
|
|
|
1177
1169
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | The information used to modify a user.
|
|
1178
1170
|
|
|
1179
1171
|
opts = {
|
|
1180
|
-
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1172
|
+
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1181
1173
|
}
|
|
1182
1174
|
|
|
1183
1175
|
begin
|
|
@@ -1195,7 +1187,7 @@ Name | Type | Description | Notes
|
|
|
1195
1187
|
------------- | ------------- | ------------- | -------------
|
|
1196
1188
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
1197
1189
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| The information used to modify a user. | |
|
|
1198
|
-
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1190
|
+
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1199
1191
|
{: class="table table-striped"}
|
|
1200
1192
|
|
|
1201
1193
|
|
|
@@ -1249,7 +1241,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
|
|
|
1249
1241
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | The information used to modify a group.
|
|
1250
1242
|
|
|
1251
1243
|
opts = {
|
|
1252
|
-
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\".
|
|
1244
|
+
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\".
|
|
1253
1245
|
}
|
|
1254
1246
|
|
|
1255
1247
|
begin
|
|
@@ -1267,7 +1259,7 @@ Name | Type | Description | Notes
|
|
|
1267
1259
|
------------- | ------------- | ------------- | -------------
|
|
1268
1260
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
1269
1261
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| The information used to modify a group. | |
|
|
1270
|
-
**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] |
|
|
1262
|
+
**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] |
|
|
1271
1263
|
{: class="table table-striped"}
|
|
1272
1264
|
|
|
1273
1265
|
|
|
@@ -1322,7 +1314,7 @@ user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/
|
|
|
1322
1314
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | The information used to modify a user.
|
|
1323
1315
|
|
|
1324
1316
|
opts = {
|
|
1325
|
-
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1317
|
+
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1326
1318
|
}
|
|
1327
1319
|
|
|
1328
1320
|
begin
|
|
@@ -1340,7 +1332,7 @@ Name | Type | Description | Notes
|
|
|
1340
1332
|
------------- | ------------- | ------------- | -------------
|
|
1341
1333
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
1342
1334
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| The information used to modify a user. | |
|
|
1343
|
-
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1335
|
+
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1344
1336
|
{: class="table table-striped"}
|
|
1345
1337
|
|
|
1346
1338
|
|
|
@@ -1524,7 +1516,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
|
|
|
1524
1516
|
body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to replace a group.
|
|
1525
1517
|
|
|
1526
1518
|
opts = {
|
|
1527
|
-
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1519
|
+
if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1528
1520
|
}
|
|
1529
1521
|
|
|
1530
1522
|
begin
|
|
@@ -1542,7 +1534,7 @@ Name | Type | Description | Notes
|
|
|
1542
1534
|
------------- | ------------- | ------------- | -------------
|
|
1543
1535
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
|
|
1544
1536
|
**body** | [**ScimV2Group**](ScimV2Group.html)| The information used to replace a group. | |
|
|
1545
|
-
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1537
|
+
**if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1546
1538
|
{: class="table table-striped"}
|
|
1547
1539
|
|
|
1548
1540
|
|
|
@@ -1597,7 +1589,7 @@ user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/
|
|
|
1597
1589
|
body = PureCloud::ScimV2User.new # ScimV2User | The information used to replace a user.
|
|
1598
1590
|
|
|
1599
1591
|
opts = {
|
|
1600
|
-
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1592
|
+
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1601
1593
|
}
|
|
1602
1594
|
|
|
1603
1595
|
begin
|
|
@@ -1615,7 +1607,7 @@ Name | Type | Description | Notes
|
|
|
1615
1607
|
------------- | ------------- | ------------- | -------------
|
|
1616
1608
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
1617
1609
|
**body** | [**ScimV2User**](ScimV2User.html)| The information used to replace a user. | |
|
|
1618
|
-
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1610
|
+
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1619
1611
|
{: class="table table-striped"}
|
|
1620
1612
|
|
|
1621
1613
|
|
|
@@ -1669,7 +1661,7 @@ group_id = "group_id_example" # String | The ID of a group. Returned with GET /a
|
|
|
1669
1661
|
body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to replace a group.
|
|
1670
1662
|
|
|
1671
1663
|
opts = {
|
|
1672
|
-
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\".
|
|
1664
|
+
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\".
|
|
1673
1665
|
}
|
|
1674
1666
|
|
|
1675
1667
|
begin
|
|
@@ -1687,7 +1679,7 @@ Name | Type | Description | Notes
|
|
|
1687
1679
|
------------- | ------------- | ------------- | -------------
|
|
1688
1680
|
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
1689
1681
|
**body** | [**ScimV2Group**](ScimV2Group.html)| The information used to replace a group. | |
|
|
1690
|
-
**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] |
|
|
1682
|
+
**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] |
|
|
1691
1683
|
{: class="table table-striped"}
|
|
1692
1684
|
|
|
1693
1685
|
|
|
@@ -1742,7 +1734,7 @@ user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/
|
|
|
1742
1734
|
body = PureCloud::ScimV2User.new # ScimV2User | The information used to replace a user.
|
|
1743
1735
|
|
|
1744
1736
|
opts = {
|
|
1745
|
-
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1737
|
+
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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1746
1738
|
}
|
|
1747
1739
|
|
|
1748
1740
|
begin
|
|
@@ -1760,7 +1752,7 @@ Name | Type | Description | Notes
|
|
|
1760
1752
|
------------- | ------------- | ------------- | -------------
|
|
1761
1753
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
1762
1754
|
**body** | [**ScimV2User**](ScimV2User.html)| The information used to replace a user. | |
|
|
1763
|
-
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\". | [optional] |
|
|
1755
|
+
**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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". | [optional] |
|
|
1764
1756
|
{: class="table table-striped"}
|
|
1765
1757
|
|
|
1766
1758
|
|