purecloudplatformclientv2 42.0.0 → 43.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/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +2 -2
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/AnalyticsApi.md +66 -0
- data/docs/AnalyticsSurvey.md +1 -0
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/AttributeEntityListing.md +2 -2
- data/docs/AuthorizationApi.md +1278 -185
- data/docs/AuthzDivision.md +18 -0
- data/docs/AuthzDivisionEntityListing.md +22 -0
- data/docs/AuthzGrant.md +16 -0
- data/docs/AuthzGrantPolicy.md +16 -0
- data/docs/AuthzGrantRole.md +18 -0
- data/docs/AuthzSubject.md +17 -0
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/CampaignDivisionViewListing.md +2 -2
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/CertificateDetails.md +1 -1
- data/docs/ChatBadgeNotificationBadgeEntity.md +1 -3
- data/docs/ChatBadgeNotificationEntity.md +1 -3
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/ClientAppEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/ConversationQuery.md +1 -0
- data/docs/CreateCallbackCommand.md +1 -0
- data/docs/CreateCallbackOnConversationCommand.md +1 -0
- data/docs/CreateQueueRequest.md +1 -1
- data/docs/CredentialInfoListing.md +2 -2
- data/docs/CredentialTypeListing.md +2 -2
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DataTableRowEntityListing.md +2 -2
- data/docs/DataTablesDomainEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/DirectoryUserDevicesListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/Document.md +1 -1
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/DomainEntityListingSurveyForm.md +2 -2
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EmergencyGroupListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/EndpointEntityListing.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FacebookIntegration.md +24 -0
- data/docs/FacebookIntegrationEntityListing.md +22 -0
- data/docs/FacebookIntegrationRequest.md +20 -0
- data/docs/FaxDocument.md +1 -1
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/FlowDivisionViewEntityListing.md +2 -2
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/FlowsApi.md +78 -0
- data/docs/GDPRRequestEntityListing.md +2 -2
- data/docs/GDPRSubjectEntityListing.md +2 -2
- data/docs/GKNDocumentationResult.md +16 -0
- data/docs/GKNDocumentationSearchCriteria.md +20 -0
- data/docs/GKNDocumentationSearchRequest.md +18 -0
- data/docs/GKNDocumentationSearchResponse.md +21 -0
- data/docs/GSuite.md +1 -1
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/GroupsApi.md +1 -1
- data/docs/IVREntityListing.md +2 -2
- data/docs/IdentityNow.md +1 -1
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/IntegrationEntityListing.md +2 -2
- data/docs/IntegrationEventEntityListing.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +2 -2
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/JsonNode.md +6 -6
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LineIntegration.md +24 -0
- data/docs/LineIntegrationEntityListing.md +22 -0
- data/docs/LineIntegrationRequest.md +19 -0
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/MessageConversationEntityListing.md +2 -2
- data/docs/MessagingApi.md +1015 -0
- data/docs/MessagingSticker.md +22 -0
- data/docs/MessagingStickerEntityListing.md +22 -0
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/ObjectsApi.md +554 -0
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OrgUser.md +3 -1
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundApi.md +2 -2
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PingIdentity.md +1 -1
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PresenceApi.md +66 -0
- data/docs/PromptAsset.md +1 -0
- data/docs/PromptAssetCreate.md +1 -0
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityAuditPage.md +2 -2
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/QueueRequest.md +1 -1
- data/docs/RecipientListing.md +2 -2
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ReportingExportJobListing.md +2 -2
- data/docs/ResponseConfig.md +1 -0
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RoutingApi.md +144 -4
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/Salesforce.md +1 -1
- data/docs/ScheduleEntityListing.md +2 -2
- data/docs/ScheduleGroupEntityListing.md +2 -2
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SearchApi.md +132 -2
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/ShareEntityListing.md +2 -2
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/StationEntityListing.md +2 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
- data/docs/SubjectDivisions.md +14 -0
- data/docs/SuggestApi.md +2 -2
- data/docs/SurveyFormEntityListing.md +2 -2
- data/docs/SystemPromptAsset.md +1 -0
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TextMessageListing.md +2 -2
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrustEntityListing.md +2 -2
- data/docs/TrustUser.md +3 -1
- data/docs/TrustUserEntityListing.md +2 -2
- data/docs/TrustorEntityListing.md +2 -2
- data/docs/TwitterIntegration.md +28 -0
- data/docs/TwitterIntegrationEntityListing.md +22 -0
- data/docs/TwitterIntegrationRequest.md +21 -0
- data/docs/UpdateUser.md +1 -1
- data/docs/UpdateWeekScheduleRequest.md +1 -0
- data/docs/User.md +3 -1
- data/docs/UserActionCategoryEntityListing.md +2 -2
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserLanguageEntityListing.md +2 -2
- data/docs/UserMe.md +3 -1
- data/docs/UserProfileEntityListing.md +2 -2
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/UsersApi.md +560 -8
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WorkforceManagementApi.md +67 -0
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/docs/WritableDialerContact.md +17 -0
- data/lib/purecloudplatformclientv2.rb +26 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +1477 -250
- data/lib/purecloudplatformclientv2/api/flows_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +1050 -0
- data/lib/purecloudplatformclientv2/api/objects_api.rb +640 -0
- data/lib/purecloudplatformclientv2/api/presence_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +157 -3
- data/lib/purecloudplatformclientv2/api/search_api.rb +131 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +607 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +64 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_survey.rb +30 -4
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/authz_division.rb +338 -0
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/authz_grant.rb +277 -0
- data/lib/purecloudplatformclientv2/models/authz_grant_policy.rb +278 -0
- data/lib/purecloudplatformclientv2/models/authz_grant_role.rb +330 -0
- data/lib/purecloudplatformclientv2/models/authz_subject.rb +305 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_badge_notification_badge_entity.rb +7 -71
- data/lib/purecloudplatformclientv2/models/chat_badge_notification_entity.rb +7 -71
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +29 -1
- data/lib/purecloudplatformclientv2/models/create_callback_command.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_callback_on_conversation_command.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +6 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/facebook_integration.rb +508 -0
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +394 -0
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +2 -2
- data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/gkn_documentation_result.rb +285 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_criteria.rb +423 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_request.rb +349 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_response.rb +444 -0
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +23 -23
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +23 -23
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/json_node.rb +89 -89
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_integration.rb +513 -0
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/line_integration_request.rb +363 -0
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +477 -0
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- data/lib/purecloudplatformclientv2/models/org_user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +26 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +26 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_request.rb +6 -0
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_config.rb +29 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/subject_divisions.rb +242 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +26 -1
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trust_user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/twitter_integration.rb +636 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_request.rb +454 -0
- data/lib/purecloudplatformclientv2/models/update_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +44 -4
- data/lib/purecloudplatformclientv2/models/user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_me.rb +58 -2
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +15 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/writable_dialer_contact.rb +320 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +54 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bd757c48f2124f4b77dabf1818a4bf5308b98998
|
4
|
+
data.tar.gz: ddcbc3a8bb72268a21adae78c3cde70a074fc095
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 49d965b58ff622902eb0d6e70f181db8809a23ae189395ae28ee317f4b6bba8b13bdaed950f1b56977b2490dfec7c8695d9088345e479d71cbcb5c70980dfe85
|
7
|
+
data.tar.gz: 61585341eb82ebb68ac30fcb53bb0a0fa4bb3287a42983bb392335bf7ac1fef542d0a9c02c07a1ac9235b16e3ab99084a55eb77ed8cedbdce808c5f0c7c92513
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
title: PureCloud Ruby Gem
|
3
3
|
---
|
4
|
-

|
5
5
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
7
7
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
10
10
|
### from rubygems.org
|
11
11
|
|
12
12
|
~~~ ruby
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 43.0.0'
|
14
14
|
~~~
|
15
15
|
|
16
16
|
### Install from Git
|
data/docs/ADFS.md
CHANGED
@@ -11,8 +11,8 @@ title: ADFS
|
|
11
11
|
| **name** | **String** | | [optional] |
|
12
12
|
| **relying_party_identifier** | **String** | | [optional] |
|
13
13
|
| **certificate** | **String** | | [optional] |
|
14
|
-
| **issuer_uri** | **String** | | [optional] |
|
15
14
|
| **sso_target_uri** | **String** | | [optional] |
|
15
|
+
| **issuer_uri** | **String** | | [optional] |
|
16
16
|
| **disabled** | **BOOLEAN** | | [optional] |
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
18
18
|
{: class="table table-striped"}
|
data/docs/ActionEntityListing.md
CHANGED
@@ -12,10 +12,10 @@ title: ActionEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: AgentActivityEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/AnalyticsApi.md
CHANGED
@@ -24,6 +24,7 @@ Method | Description
|
|
24
24
|
[**post_analytics_conversations_aggregates_query**](AnalyticsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
|
25
25
|
[**post_analytics_conversations_details_query**](AnalyticsApi.html#post_analytics_conversations_details_query) | Query for conversation details
|
26
26
|
[**post_analytics_evaluations_aggregates_query**](AnalyticsApi.html#post_analytics_evaluations_aggregates_query) | Query for evaluation aggregates
|
27
|
+
[**post_analytics_flows_aggregates_query**](AnalyticsApi.html#post_analytics_flows_aggregates_query) | Query for flow aggregates
|
27
28
|
[**post_analytics_queues_observations_query**](AnalyticsApi.html#post_analytics_queues_observations_query) | Query for queue observations
|
28
29
|
[**post_analytics_reporting_exports**](AnalyticsApi.html#post_analytics_reporting_exports) | Generate a view export request
|
29
30
|
[**post_analytics_reporting_schedule_runreport**](AnalyticsApi.html#post_analytics_reporting_schedule_runreport) | Place a scheduled report immediately into the reporting queue
|
@@ -1069,6 +1070,71 @@ Name | Type | Description | Notes
|
|
1069
1070
|
|
1070
1071
|
|
1071
1072
|
|
1073
|
+
<a name="post_analytics_flows_aggregates_query"></a>
|
1074
|
+
|
1075
|
+
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_flows_aggregates_query(body)
|
1076
|
+
|
1077
|
+
|
1078
|
+
|
1079
|
+
Query for flow aggregates
|
1080
|
+
|
1081
|
+
|
1082
|
+
|
1083
|
+
Wraps POST /api/v2/analytics/flows/aggregates/query
|
1084
|
+
|
1085
|
+
Requires ANY permissions:
|
1086
|
+
|
1087
|
+
* analytics:flowAggregate:view
|
1088
|
+
|
1089
|
+
|
1090
|
+
### Example
|
1091
|
+
~~~ruby
|
1092
|
+
# load the gem
|
1093
|
+
require 'purecloudplatformclientv2'
|
1094
|
+
# setup authorization
|
1095
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1096
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1097
|
+
environment = "mypurecloud.com"
|
1098
|
+
|
1099
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1100
|
+
|
1101
|
+
PureCloud.configure do |config|
|
1102
|
+
config.access_token = @authToken
|
1103
|
+
end
|
1104
|
+
|
1105
|
+
api_instance = PureCloud::AnalyticsApi.new
|
1106
|
+
|
1107
|
+
body = PureCloud::AggregationQuery.new # AggregationQuery | query
|
1108
|
+
|
1109
|
+
|
1110
|
+
begin
|
1111
|
+
#Query for flow aggregates
|
1112
|
+
result = api_instance.post_analytics_flows_aggregates_query(body)
|
1113
|
+
p result
|
1114
|
+
rescue PureCloud::ApiError => e
|
1115
|
+
puts "Exception when calling AnalyticsApi->post_analytics_flows_aggregates_query: #{e}"
|
1116
|
+
end
|
1117
|
+
~~~
|
1118
|
+
|
1119
|
+
### Parameters
|
1120
|
+
|
1121
|
+
Name | Type | Description | Notes
|
1122
|
+
------------- | ------------- | ------------- | -------------
|
1123
|
+
**body** | [**AggregationQuery**](AggregationQuery.html)| query | |
|
1124
|
+
{: class="table table-striped"}
|
1125
|
+
|
1126
|
+
|
1127
|
+
### Return type
|
1128
|
+
|
1129
|
+
[**AggregateQueryResponse**](AggregateQueryResponse.html)
|
1130
|
+
|
1131
|
+
### HTTP request headers
|
1132
|
+
|
1133
|
+
- **Content-Type**: application/json
|
1134
|
+
- **Accept**: application/json
|
1135
|
+
|
1136
|
+
|
1137
|
+
|
1072
1138
|
<a name="post_analytics_queues_observations_query"></a>
|
1073
1139
|
|
1074
1140
|
## -[**QualifierMappingObservationQueryResponse**](QualifierMappingObservationQueryResponse.html) post_analytics_queues_observations_query(body)
|
data/docs/AnalyticsSurvey.md
CHANGED
@@ -17,6 +17,7 @@ title: AnalyticsSurvey
|
|
17
17
|
| **queue_id** | **String** | Unique identifier for the queue the conversation was on | [optional] |
|
18
18
|
| **status** | **String** | Survey status | [optional] |
|
19
19
|
| **created_date** | **DateTime** | Creation date of survey. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
20
|
+
| **geto_survey_total_score** | **Integer** | The total score for the survey | [optional] |
|
20
21
|
{: class="table table-striped"}
|
21
22
|
|
22
23
|
|
@@ -12,10 +12,10 @@ title: AttemptLimitsEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: AttributeEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/AuthorizationApi.md
CHANGED
@@ -8,19 +8,35 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
[**delete_authorization_division**](AuthorizationApi.html#delete_authorization_division) | Delete a division.
|
11
12
|
[**delete_authorization_role**](AuthorizationApi.html#delete_authorization_role) | Delete an organization role.
|
13
|
+
[**delete_authorization_subject_division_role**](AuthorizationApi.html#delete_authorization_subject_division_role) | Delete a grant of a role in a division
|
12
14
|
[**delete_user_roles**](AuthorizationApi.html#delete_user_roles) | Removes all the roles from the user.
|
15
|
+
[**get_authorization_division**](AuthorizationApi.html#get_authorization_division) | Returns an authorization division.
|
16
|
+
[**get_authorization_divisions**](AuthorizationApi.html#get_authorization_divisions) | Retrieve a list of all divisions defined for the organization
|
17
|
+
[**get_authorization_divisions_home**](AuthorizationApi.html#get_authorization_divisions_home) | Retrieve the home division for the organization.
|
18
|
+
[**get_authorization_divisions_limit**](AuthorizationApi.html#get_authorization_divisions_limit) | Returns the maximum allowed number of divisions.
|
19
|
+
[**get_authorization_divisionspermitted_me**](AuthorizationApi.html#get_authorization_divisionspermitted_me) | Returns whether or not current user can perform the specified action(s).
|
20
|
+
[**get_authorization_divisionspermitted_subject_id**](AuthorizationApi.html#get_authorization_divisionspermitted_subject_id) | Returns whether or not specified user can perform the specified action(s).
|
13
21
|
[**get_authorization_permissions**](AuthorizationApi.html#get_authorization_permissions) | Get all permissions.
|
14
22
|
[**get_authorization_products**](AuthorizationApi.html#get_authorization_products) | Get the list of enabled products
|
15
23
|
[**get_authorization_role**](AuthorizationApi.html#get_authorization_role) | Get a single organization role.
|
16
24
|
[**get_authorization_role_comparedefault_right_role_id**](AuthorizationApi.html#get_authorization_role_comparedefault_right_role_id) | Get an org role to default role comparison comparison
|
17
25
|
[**get_authorization_role_subjectgrants**](AuthorizationApi.html#get_authorization_role_subjectgrants) | Get the subjects' granted divisions in the specified role.
|
26
|
+
[**get_authorization_role_users**](AuthorizationApi.html#get_authorization_role_users) | Get a list of the users in a specified role.
|
18
27
|
[**get_authorization_roles**](AuthorizationApi.html#get_authorization_roles) | Retrieve a list of all roles defined for the organization
|
28
|
+
[**get_authorization_subject**](AuthorizationApi.html#get_authorization_subject) | Returns a listing of roles and permissions for a user.
|
29
|
+
[**get_authorization_subjects_me**](AuthorizationApi.html#get_authorization_subjects_me) | Returns a listing of roles and permissions for the currently authenticated user.
|
19
30
|
[**get_user_roles**](AuthorizationApi.html#get_user_roles) | Returns a listing of roles and permissions for a user.
|
20
31
|
[**patch_authorization_role**](AuthorizationApi.html#patch_authorization_role) | Patch Organization Role for needsUpdate Field
|
32
|
+
[**post_authorization_division_object**](AuthorizationApi.html#post_authorization_division_object) | Assign a list of objects to a division
|
33
|
+
[**post_authorization_divisions**](AuthorizationApi.html#post_authorization_divisions) | Create a division.
|
34
|
+
[**post_authorization_role**](AuthorizationApi.html#post_authorization_role) | Bulk-grant subjects and divisions with an organization role.
|
21
35
|
[**post_authorization_role_comparedefault_right_role_id**](AuthorizationApi.html#post_authorization_role_comparedefault_right_role_id) | Get an unsaved org role to default role comparison
|
22
36
|
[**post_authorization_roles**](AuthorizationApi.html#post_authorization_roles) | Create an organization role.
|
23
37
|
[**post_authorization_roles_default**](AuthorizationApi.html#post_authorization_roles_default) | Restores all default roles
|
38
|
+
[**post_authorization_subject_division_role**](AuthorizationApi.html#post_authorization_subject_division_role) | Make a grant of a role in a division
|
39
|
+
[**put_authorization_division**](AuthorizationApi.html#put_authorization_division) | Update a division.
|
24
40
|
[**put_authorization_role**](AuthorizationApi.html#put_authorization_role) | Update an organization role.
|
25
41
|
[**put_authorization_role_users_add**](AuthorizationApi.html#put_authorization_role_users_add) | Sets the users for the role
|
26
42
|
[**put_authorization_role_users_remove**](AuthorizationApi.html#put_authorization_role_users_remove) | Removes the users from the role
|
@@ -28,23 +44,21 @@ Method | Description
|
|
28
44
|
[**put_user_roles**](AuthorizationApi.html#put_user_roles) | Sets the user's roles
|
29
45
|
{: class="table table-striped"}
|
30
46
|
|
31
|
-
<a name="
|
47
|
+
<a name="delete_authorization_division"></a>
|
32
48
|
|
33
|
-
## -
|
49
|
+
## - delete_authorization_division(division_id)
|
34
50
|
|
35
51
|
|
36
52
|
|
37
|
-
Delete
|
53
|
+
Delete a division.
|
38
54
|
|
39
55
|
|
40
56
|
|
41
|
-
Wraps DELETE /api/v2/authorization/
|
57
|
+
Wraps DELETE /api/v2/authorization/divisions/{divisionId}
|
42
58
|
|
43
59
|
Requires ANY permissions:
|
44
60
|
|
45
|
-
*
|
46
|
-
* role_manager
|
47
|
-
* authorization:role:delete
|
61
|
+
* authorization:division:delete
|
48
62
|
|
49
63
|
|
50
64
|
### Example
|
@@ -64,14 +78,14 @@ end
|
|
64
78
|
|
65
79
|
api_instance = PureCloud::AuthorizationApi.new
|
66
80
|
|
67
|
-
|
81
|
+
division_id = "division_id_example" # String | Division ID
|
68
82
|
|
69
83
|
|
70
84
|
begin
|
71
|
-
#Delete
|
72
|
-
api_instance.
|
85
|
+
#Delete a division.
|
86
|
+
api_instance.delete_authorization_division(division_id)
|
73
87
|
rescue PureCloud::ApiError => e
|
74
|
-
puts "Exception when calling AuthorizationApi->
|
88
|
+
puts "Exception when calling AuthorizationApi->delete_authorization_division: #{e}"
|
75
89
|
end
|
76
90
|
~~~
|
77
91
|
|
@@ -79,7 +93,7 @@ end
|
|
79
93
|
|
80
94
|
Name | Type | Description | Notes
|
81
95
|
------------- | ------------- | ------------- | -------------
|
82
|
-
**
|
96
|
+
**division_id** | **String**| Division ID | |
|
83
97
|
{: class="table table-striped"}
|
84
98
|
|
85
99
|
|
@@ -94,23 +108,23 @@ nil (empty response body)
|
|
94
108
|
|
95
109
|
|
96
110
|
|
97
|
-
<a name="
|
111
|
+
<a name="delete_authorization_role"></a>
|
98
112
|
|
99
|
-
## -
|
113
|
+
## - delete_authorization_role(role_id)
|
100
114
|
|
101
115
|
|
102
116
|
|
103
|
-
|
117
|
+
Delete an organization role.
|
104
118
|
|
105
119
|
|
106
120
|
|
107
|
-
Wraps DELETE /api/v2/
|
121
|
+
Wraps DELETE /api/v2/authorization/roles/{roleId}
|
108
122
|
|
109
123
|
Requires ANY permissions:
|
110
124
|
|
111
125
|
* admin
|
112
126
|
* role_manager
|
113
|
-
* authorization:
|
127
|
+
* authorization:role:delete
|
114
128
|
|
115
129
|
|
116
130
|
### Example
|
@@ -130,14 +144,14 @@ end
|
|
130
144
|
|
131
145
|
api_instance = PureCloud::AuthorizationApi.new
|
132
146
|
|
133
|
-
|
147
|
+
role_id = "role_id_example" # String | Role ID
|
134
148
|
|
135
149
|
|
136
150
|
begin
|
137
|
-
#
|
138
|
-
api_instance.
|
151
|
+
#Delete an organization role.
|
152
|
+
api_instance.delete_authorization_role(role_id)
|
139
153
|
rescue PureCloud::ApiError => e
|
140
|
-
puts "Exception when calling AuthorizationApi->
|
154
|
+
puts "Exception when calling AuthorizationApi->delete_authorization_role: #{e}"
|
141
155
|
end
|
142
156
|
~~~
|
143
157
|
|
@@ -145,7 +159,7 @@ end
|
|
145
159
|
|
146
160
|
Name | Type | Description | Notes
|
147
161
|
------------- | ------------- | ------------- | -------------
|
148
|
-
**
|
162
|
+
**role_id** | **String**| Role ID | |
|
149
163
|
{: class="table table-striped"}
|
150
164
|
|
151
165
|
|
@@ -160,20 +174,21 @@ nil (empty response body)
|
|
160
174
|
|
161
175
|
|
162
176
|
|
163
|
-
<a name="
|
177
|
+
<a name="delete_authorization_subject_division_role"></a>
|
164
178
|
|
165
|
-
## -
|
179
|
+
## - delete_authorization_subject_division_role(subject_id, division_id, role_id)
|
166
180
|
|
167
181
|
|
168
182
|
|
169
|
-
|
183
|
+
Delete a grant of a role in a division
|
170
184
|
|
171
|
-
Retrieve a list of all permission defined in the system.
|
172
185
|
|
173
|
-
Wraps GET /api/v2/authorization/permissions
|
174
186
|
|
175
|
-
|
187
|
+
Wraps DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
|
188
|
+
|
189
|
+
Requires ANY permissions:
|
176
190
|
|
191
|
+
* authorization:grant:delete
|
177
192
|
|
178
193
|
|
179
194
|
### Example
|
@@ -193,17 +208,18 @@ end
|
|
193
208
|
|
194
209
|
api_instance = PureCloud::AuthorizationApi.new
|
195
210
|
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
211
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
212
|
+
|
213
|
+
division_id = "division_id_example" # String | the id of the division of the grant
|
214
|
+
|
215
|
+
role_id = "role_id_example" # String | the id of the role of the grant
|
216
|
+
|
200
217
|
|
201
218
|
begin
|
202
|
-
#
|
203
|
-
|
204
|
-
p result
|
219
|
+
#Delete a grant of a role in a division
|
220
|
+
api_instance.delete_authorization_subject_division_role(subject_id, division_id, role_id)
|
205
221
|
rescue PureCloud::ApiError => e
|
206
|
-
puts "Exception when calling AuthorizationApi->
|
222
|
+
puts "Exception when calling AuthorizationApi->delete_authorization_subject_division_role: #{e}"
|
207
223
|
end
|
208
224
|
~~~
|
209
225
|
|
@@ -211,14 +227,15 @@ end
|
|
211
227
|
|
212
228
|
Name | Type | Description | Notes
|
213
229
|
------------- | ------------- | ------------- | -------------
|
214
|
-
**
|
215
|
-
**
|
230
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
231
|
+
**division_id** | **String**| the id of the division of the grant | |
|
232
|
+
**role_id** | **String**| the id of the role of the grant | |
|
216
233
|
{: class="table table-striped"}
|
217
234
|
|
218
235
|
|
219
236
|
### Return type
|
220
237
|
|
221
|
-
|
238
|
+
nil (empty response body)
|
222
239
|
|
223
240
|
### HTTP request headers
|
224
241
|
|
@@ -227,20 +244,23 @@ Name | Type | Description | Notes
|
|
227
244
|
|
228
245
|
|
229
246
|
|
230
|
-
<a name="
|
247
|
+
<a name="delete_user_roles"></a>
|
231
248
|
|
232
|
-
## -
|
249
|
+
## - delete_user_roles(user_id)
|
233
250
|
|
234
251
|
|
235
252
|
|
236
|
-
|
253
|
+
Removes all the roles from the user.
|
237
254
|
|
238
|
-
Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
|
239
255
|
|
240
|
-
Wraps GET /api/v2/authorization/products
|
241
256
|
|
242
|
-
|
257
|
+
Wraps DELETE /api/v2/users/{userId}/roles
|
258
|
+
|
259
|
+
Requires ANY permissions:
|
243
260
|
|
261
|
+
* admin
|
262
|
+
* role_manager
|
263
|
+
* authorization:grant:delete
|
244
264
|
|
245
265
|
|
246
266
|
### Example
|
@@ -260,23 +280,28 @@ end
|
|
260
280
|
|
261
281
|
api_instance = PureCloud::AuthorizationApi.new
|
262
282
|
|
283
|
+
user_id = "user_id_example" # String | User ID
|
284
|
+
|
285
|
+
|
263
286
|
begin
|
264
|
-
#
|
265
|
-
|
266
|
-
p result
|
287
|
+
#Removes all the roles from the user.
|
288
|
+
api_instance.delete_user_roles(user_id)
|
267
289
|
rescue PureCloud::ApiError => e
|
268
|
-
puts "Exception when calling AuthorizationApi->
|
290
|
+
puts "Exception when calling AuthorizationApi->delete_user_roles: #{e}"
|
269
291
|
end
|
270
292
|
~~~
|
271
293
|
|
272
294
|
### Parameters
|
273
|
-
|
295
|
+
|
296
|
+
Name | Type | Description | Notes
|
297
|
+
------------- | ------------- | ------------- | -------------
|
298
|
+
**user_id** | **String**| User ID | |
|
274
299
|
{: class="table table-striped"}
|
275
300
|
|
276
301
|
|
277
302
|
### Return type
|
278
303
|
|
279
|
-
|
304
|
+
nil (empty response body)
|
280
305
|
|
281
306
|
### HTTP request headers
|
282
307
|
|
@@ -285,21 +310,20 @@ This endpoint does not need any parameter.
|
|
285
310
|
|
286
311
|
|
287
312
|
|
288
|
-
<a name="
|
313
|
+
<a name="get_authorization_division"></a>
|
289
314
|
|
290
|
-
## -[**
|
315
|
+
## -[**AuthzDivision**](AuthzDivision.html) get_authorization_division(division_id, opts)
|
291
316
|
|
292
317
|
|
293
318
|
|
294
|
-
|
319
|
+
Returns an authorization division.
|
295
320
|
|
296
|
-
Get the organization role specified by its ID.
|
297
321
|
|
298
|
-
Wraps GET /api/v2/authorization/roles/{roleId}
|
299
322
|
|
300
|
-
|
323
|
+
Wraps GET /api/v2/authorization/divisions/{divisionId}
|
324
|
+
|
325
|
+
Requires NO permissions:
|
301
326
|
|
302
|
-
* authorization:role:view
|
303
327
|
|
304
328
|
|
305
329
|
### Example
|
@@ -319,15 +343,18 @@ end
|
|
319
343
|
|
320
344
|
api_instance = PureCloud::AuthorizationApi.new
|
321
345
|
|
322
|
-
|
346
|
+
division_id = "division_id_example" # String | Division ID
|
323
347
|
|
348
|
+
opts = {
|
349
|
+
object_count: false # BOOLEAN | Get count of objects in this division, grouped by type
|
350
|
+
}
|
324
351
|
|
325
352
|
begin
|
326
|
-
#
|
327
|
-
result = api_instance.
|
353
|
+
#Returns an authorization division.
|
354
|
+
result = api_instance.get_authorization_division(division_id, opts)
|
328
355
|
p result
|
329
356
|
rescue PureCloud::ApiError => e
|
330
|
-
puts "Exception when calling AuthorizationApi->
|
357
|
+
puts "Exception when calling AuthorizationApi->get_authorization_division: #{e}"
|
331
358
|
end
|
332
359
|
~~~
|
333
360
|
|
@@ -335,13 +362,14 @@ end
|
|
335
362
|
|
336
363
|
Name | Type | Description | Notes
|
337
364
|
------------- | ------------- | ------------- | -------------
|
338
|
-
**
|
365
|
+
**division_id** | **String**| Division ID | |
|
366
|
+
**object_count** | **BOOLEAN**| Get count of objects in this division, grouped by type | [optional] [default to false] |
|
339
367
|
{: class="table table-striped"}
|
340
368
|
|
341
369
|
|
342
370
|
### Return type
|
343
371
|
|
344
|
-
[**
|
372
|
+
[**AuthzDivision**](AuthzDivision.html)
|
345
373
|
|
346
374
|
### HTTP request headers
|
347
375
|
|
@@ -350,21 +378,20 @@ Name | Type | Description | Notes
|
|
350
378
|
|
351
379
|
|
352
380
|
|
353
|
-
<a name="
|
381
|
+
<a name="get_authorization_divisions"></a>
|
354
382
|
|
355
|
-
## -[**
|
383
|
+
## -[**AuthzDivisionEntityListing**](AuthzDivisionEntityListing.html) get_authorization_divisions(opts)
|
356
384
|
|
357
385
|
|
358
386
|
|
359
|
-
|
387
|
+
Retrieve a list of all divisions defined for the organization
|
360
388
|
|
361
|
-
|
389
|
+
Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3
|
362
390
|
|
363
|
-
Wraps GET /api/v2/authorization/
|
391
|
+
Wraps GET /api/v2/authorization/divisions
|
364
392
|
|
365
|
-
Requires
|
393
|
+
Requires NO permissions:
|
366
394
|
|
367
|
-
* authorization:role:view
|
368
395
|
|
369
396
|
|
370
397
|
### Example
|
@@ -384,17 +411,24 @@ end
|
|
384
411
|
|
385
412
|
api_instance = PureCloud::AuthorizationApi.new
|
386
413
|
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
414
|
+
opts = {
|
415
|
+
page_size: 25, # Integer | The total page size requested
|
416
|
+
page_number: 1, # Integer | The page number requested
|
417
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
418
|
+
expand: ["expand_example"], # Array<String> | variable name requested by expand list
|
419
|
+
next_page: "next_page_example", # String | next page token
|
420
|
+
previous_page: "previous_page_example", # String | Previous page token
|
421
|
+
object_count: false, # BOOLEAN | Include the count of objects contained in the division
|
422
|
+
id: ["id_example"], # Array<String> | Optionally request specific divisions by their IDs
|
423
|
+
name: "name_example" # String | Search term to filter by division name
|
424
|
+
}
|
391
425
|
|
392
426
|
begin
|
393
|
-
#
|
394
|
-
result = api_instance.
|
427
|
+
#Retrieve a list of all divisions defined for the organization
|
428
|
+
result = api_instance.get_authorization_divisions(opts)
|
395
429
|
p result
|
396
430
|
rescue PureCloud::ApiError => e
|
397
|
-
puts "Exception when calling AuthorizationApi->
|
431
|
+
puts "Exception when calling AuthorizationApi->get_authorization_divisions: #{e}"
|
398
432
|
end
|
399
433
|
~~~
|
400
434
|
|
@@ -402,14 +436,21 @@ end
|
|
402
436
|
|
403
437
|
Name | Type | Description | Notes
|
404
438
|
------------- | ------------- | ------------- | -------------
|
405
|
-
**
|
406
|
-
**
|
439
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
440
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
441
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
442
|
+
**expand** | [**Array<String>**](String.html)| variable name requested by expand list | [optional] |
|
443
|
+
**next_page** | **String**| next page token | [optional] |
|
444
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
445
|
+
**object_count** | **BOOLEAN**| Include the count of objects contained in the division | [optional] [default to false] |
|
446
|
+
**id** | [**Array<String>**](String.html)| Optionally request specific divisions by their IDs | [optional] |
|
447
|
+
**name** | **String**| Search term to filter by division name | [optional] |
|
407
448
|
{: class="table table-striped"}
|
408
449
|
|
409
450
|
|
410
451
|
### Return type
|
411
452
|
|
412
|
-
[**
|
453
|
+
[**AuthzDivisionEntityListing**](AuthzDivisionEntityListing.html)
|
413
454
|
|
414
455
|
### HTTP request headers
|
415
456
|
|
@@ -418,21 +459,21 @@ Name | Type | Description | Notes
|
|
418
459
|
|
419
460
|
|
420
461
|
|
421
|
-
<a name="
|
462
|
+
<a name="get_authorization_divisions_home"></a>
|
422
463
|
|
423
|
-
## -[**
|
464
|
+
## -[**AuthzDivision**](AuthzDivision.html) get_authorization_divisions_home
|
424
465
|
|
425
466
|
|
426
467
|
|
427
|
-
|
468
|
+
Retrieve the home division for the organization.
|
428
469
|
|
429
|
-
|
470
|
+
Will not include object counts.
|
430
471
|
|
431
|
-
Wraps GET /api/v2/authorization/
|
472
|
+
Wraps GET /api/v2/authorization/divisions/home
|
432
473
|
|
433
474
|
Requires ANY permissions:
|
434
475
|
|
435
|
-
* authorization:
|
476
|
+
* authorization:division:view
|
436
477
|
|
437
478
|
|
438
479
|
### Example
|
@@ -452,43 +493,23 @@ end
|
|
452
493
|
|
453
494
|
api_instance = PureCloud::AuthorizationApi.new
|
454
495
|
|
455
|
-
role_id = "role_id_example" # String | Role ID
|
456
|
-
|
457
|
-
opts = {
|
458
|
-
page_size: 25, # Integer | The total page size requested
|
459
|
-
page_number: 1, # Integer | The page number requested
|
460
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
461
|
-
expand: ["expand_example"], # Array<String> | variable name requested by expand list
|
462
|
-
next_page: "next_page_example", # String | next page token
|
463
|
-
previous_page: "previous_page_example" # String | Previous page token
|
464
|
-
}
|
465
|
-
|
466
496
|
begin
|
467
|
-
#
|
468
|
-
result = api_instance.
|
497
|
+
#Retrieve the home division for the organization.
|
498
|
+
result = api_instance.get_authorization_divisions_home
|
469
499
|
p result
|
470
500
|
rescue PureCloud::ApiError => e
|
471
|
-
puts "Exception when calling AuthorizationApi->
|
501
|
+
puts "Exception when calling AuthorizationApi->get_authorization_divisions_home: #{e}"
|
472
502
|
end
|
473
503
|
~~~
|
474
504
|
|
475
505
|
### Parameters
|
476
|
-
|
477
|
-
Name | Type | Description | Notes
|
478
|
-
------------- | ------------- | ------------- | -------------
|
479
|
-
**role_id** | **String**| Role ID | |
|
480
|
-
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
481
|
-
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
482
|
-
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
483
|
-
**expand** | [**Array<String>**](String.html)| variable name requested by expand list | [optional] |
|
484
|
-
**next_page** | **String**| next page token | [optional] |
|
485
|
-
**previous_page** | **String**| Previous page token | [optional] |
|
506
|
+
This endpoint does not need any parameter.
|
486
507
|
{: class="table table-striped"}
|
487
508
|
|
488
509
|
|
489
510
|
### Return type
|
490
511
|
|
491
|
-
[**
|
512
|
+
[**AuthzDivision**](AuthzDivision.html)
|
492
513
|
|
493
514
|
### HTTP request headers
|
494
515
|
|
@@ -497,21 +518,21 @@ Name | Type | Description | Notes
|
|
497
518
|
|
498
519
|
|
499
520
|
|
500
|
-
<a name="
|
521
|
+
<a name="get_authorization_divisions_limit"></a>
|
501
522
|
|
502
|
-
## -
|
523
|
+
## -Integer** get_authorization_divisions_limit
|
503
524
|
|
504
525
|
|
505
526
|
|
506
|
-
|
527
|
+
Returns the maximum allowed number of divisions.
|
507
528
|
|
508
529
|
|
509
530
|
|
510
|
-
Wraps GET /api/v2/authorization/
|
531
|
+
Wraps GET /api/v2/authorization/divisions/limit
|
511
532
|
|
512
533
|
Requires ANY permissions:
|
513
534
|
|
514
|
-
* authorization:
|
535
|
+
* authorization:division:view
|
515
536
|
|
516
537
|
|
517
538
|
### Example
|
@@ -531,50 +552,23 @@ end
|
|
531
552
|
|
532
553
|
api_instance = PureCloud::AuthorizationApi.new
|
533
554
|
|
534
|
-
opts = {
|
535
|
-
page_size: 25, # Integer | The total page size requested
|
536
|
-
page_number: 1, # Integer | The page number requested
|
537
|
-
sort_by: "sort_by_example", # String | variable name requested to sort by
|
538
|
-
expand: ["expand_example"], # Array<String> | variable name requested by expand list
|
539
|
-
next_page: "next_page_example", # String | next page token
|
540
|
-
previous_page: "previous_page_example", # String | Previous page token
|
541
|
-
name: "name_example", # String |
|
542
|
-
permission: ["permission_example"], # Array<String> |
|
543
|
-
default_role_id: ["default_role_id_example"], # Array<String> |
|
544
|
-
user_count: true, # BOOLEAN |
|
545
|
-
id: ["id_example"] # Array<String> | id
|
546
|
-
}
|
547
|
-
|
548
555
|
begin
|
549
|
-
#
|
550
|
-
result = api_instance.
|
556
|
+
#Returns the maximum allowed number of divisions.
|
557
|
+
result = api_instance.get_authorization_divisions_limit
|
551
558
|
p result
|
552
559
|
rescue PureCloud::ApiError => e
|
553
|
-
puts "Exception when calling AuthorizationApi->
|
560
|
+
puts "Exception when calling AuthorizationApi->get_authorization_divisions_limit: #{e}"
|
554
561
|
end
|
555
562
|
~~~
|
556
563
|
|
557
564
|
### Parameters
|
558
|
-
|
559
|
-
Name | Type | Description | Notes
|
560
|
-
------------- | ------------- | ------------- | -------------
|
561
|
-
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
562
|
-
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
563
|
-
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
564
|
-
**expand** | [**Array<String>**](String.html)| variable name requested by expand list | [optional] |
|
565
|
-
**next_page** | **String**| next page token | [optional] |
|
566
|
-
**previous_page** | **String**| Previous page token | [optional] |
|
567
|
-
**name** | **String**| | [optional] |
|
568
|
-
**permission** | [**Array<String>**](String.html)| | [optional] |
|
569
|
-
**default_role_id** | [**Array<String>**](String.html)| | [optional] |
|
570
|
-
**user_count** | **BOOLEAN**| | [optional] [default to true] |
|
571
|
-
**id** | [**Array<String>**](String.html)| id | [optional] |
|
565
|
+
This endpoint does not need any parameter.
|
572
566
|
{: class="table table-striped"}
|
573
567
|
|
574
568
|
|
575
569
|
### Return type
|
576
570
|
|
577
|
-
|
571
|
+
**Integer**
|
578
572
|
|
579
573
|
### HTTP request headers
|
580
574
|
|
@@ -583,21 +577,20 @@ Name | Type | Description | Notes
|
|
583
577
|
|
584
578
|
|
585
579
|
|
586
|
-
<a name="
|
580
|
+
<a name="get_authorization_divisionspermitted_me"></a>
|
587
581
|
|
588
|
-
## -[**
|
582
|
+
## -[**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
|
589
583
|
|
590
584
|
|
591
585
|
|
592
|
-
Returns
|
586
|
+
Returns whether or not current user can perform the specified action(s).
|
593
587
|
|
594
588
|
|
595
589
|
|
596
|
-
Wraps GET /api/v2/
|
590
|
+
Wraps GET /api/v2/authorization/divisionspermitted/me
|
597
591
|
|
598
|
-
Requires
|
592
|
+
Requires NO permissions:
|
599
593
|
|
600
|
-
* authorization:grant:view
|
601
594
|
|
602
595
|
|
603
596
|
### Example
|
@@ -617,15 +610,18 @@ end
|
|
617
610
|
|
618
611
|
api_instance = PureCloud::AuthorizationApi.new
|
619
612
|
|
620
|
-
|
613
|
+
permission = "permission_example" # String | The permission string, including the object to access, e.g. routing:queue:view
|
621
614
|
|
615
|
+
opts = {
|
616
|
+
name: "name_example" # String | Search term to filter by division name
|
617
|
+
}
|
622
618
|
|
623
619
|
begin
|
624
|
-
#Returns
|
625
|
-
result = api_instance.
|
620
|
+
#Returns whether or not current user can perform the specified action(s).
|
621
|
+
result = api_instance.get_authorization_divisionspermitted_me(permission, opts)
|
626
622
|
p result
|
627
623
|
rescue PureCloud::ApiError => e
|
628
|
-
puts "Exception when calling AuthorizationApi->
|
624
|
+
puts "Exception when calling AuthorizationApi->get_authorization_divisionspermitted_me: #{e}"
|
629
625
|
end
|
630
626
|
~~~
|
631
627
|
|
@@ -633,13 +629,14 @@ end
|
|
633
629
|
|
634
630
|
Name | Type | Description | Notes
|
635
631
|
------------- | ------------- | ------------- | -------------
|
636
|
-
**
|
632
|
+
**permission** | **String**| The permission string, including the object to access, e.g. routing:queue:view | |
|
633
|
+
**name** | **String**| Search term to filter by division name | [optional] |
|
637
634
|
{: class="table table-striped"}
|
638
635
|
|
639
636
|
|
640
637
|
### Return type
|
641
638
|
|
642
|
-
[**
|
639
|
+
[**Array<AuthzDivision>**](AuthzDivision.html)
|
643
640
|
|
644
641
|
### HTTP request headers
|
645
642
|
|
@@ -648,23 +645,20 @@ Name | Type | Description | Notes
|
|
648
645
|
|
649
646
|
|
650
647
|
|
651
|
-
<a name="
|
648
|
+
<a name="get_authorization_divisionspermitted_subject_id"></a>
|
652
649
|
|
653
|
-
## -[**
|
650
|
+
## -[**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
|
654
651
|
|
655
652
|
|
656
653
|
|
657
|
-
|
654
|
+
Returns whether or not specified user can perform the specified action(s).
|
658
655
|
|
659
|
-
Patch Organization Role for needsUpdate Field
|
660
656
|
|
661
|
-
Wraps PATCH /api/v2/authorization/roles/{roleId}
|
662
657
|
|
663
|
-
|
658
|
+
Wraps GET /api/v2/authorization/divisionspermitted/{subjectId}
|
659
|
+
|
660
|
+
Requires NO permissions:
|
664
661
|
|
665
|
-
* admin
|
666
|
-
* role_manager
|
667
|
-
* authorization:role:edit
|
668
662
|
|
669
663
|
|
670
664
|
### Example
|
@@ -684,17 +678,20 @@ end
|
|
684
678
|
|
685
679
|
api_instance = PureCloud::AuthorizationApi.new
|
686
680
|
|
687
|
-
|
681
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
688
682
|
|
689
|
-
|
683
|
+
permission = "permission_example" # String | The permission string, including the object to access, e.g. routing:queue:view
|
690
684
|
|
685
|
+
opts = {
|
686
|
+
name: "name_example" # String | Search term to filter by division name
|
687
|
+
}
|
691
688
|
|
692
689
|
begin
|
693
|
-
#
|
694
|
-
result = api_instance.
|
690
|
+
#Returns whether or not specified user can perform the specified action(s).
|
691
|
+
result = api_instance.get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
|
695
692
|
p result
|
696
693
|
rescue PureCloud::ApiError => e
|
697
|
-
puts "Exception when calling AuthorizationApi->
|
694
|
+
puts "Exception when calling AuthorizationApi->get_authorization_divisionspermitted_subject_id: #{e}"
|
698
695
|
end
|
699
696
|
~~~
|
700
697
|
|
@@ -702,14 +699,15 @@ end
|
|
702
699
|
|
703
700
|
Name | Type | Description | Notes
|
704
701
|
------------- | ------------- | ------------- | -------------
|
705
|
-
**
|
706
|
-
**
|
702
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
703
|
+
**permission** | **String**| The permission string, including the object to access, e.g. routing:queue:view | |
|
704
|
+
**name** | **String**| Search term to filter by division name | [optional] |
|
707
705
|
{: class="table table-striped"}
|
708
706
|
|
709
707
|
|
710
708
|
### Return type
|
711
709
|
|
712
|
-
[**
|
710
|
+
[**Array<AuthzDivision>**](AuthzDivision.html)
|
713
711
|
|
714
712
|
### HTTP request headers
|
715
713
|
|
@@ -718,21 +716,974 @@ Name | Type | Description | Notes
|
|
718
716
|
|
719
717
|
|
720
718
|
|
721
|
-
<a name="
|
719
|
+
<a name="get_authorization_permissions"></a>
|
722
720
|
|
723
|
-
## -[**
|
721
|
+
## -[**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_authorization_permissions(opts)
|
724
722
|
|
725
723
|
|
726
724
|
|
727
|
-
Get
|
725
|
+
Get all permissions.
|
728
726
|
|
729
|
-
|
727
|
+
Retrieve a list of all permission defined in the system.
|
730
728
|
|
731
|
-
Wraps
|
729
|
+
Wraps GET /api/v2/authorization/permissions
|
732
730
|
|
733
|
-
Requires
|
731
|
+
Requires NO permissions:
|
734
732
|
|
735
|
-
|
733
|
+
|
734
|
+
|
735
|
+
### Example
|
736
|
+
~~~ruby
|
737
|
+
# load the gem
|
738
|
+
require 'purecloudplatformclientv2'
|
739
|
+
# setup authorization
|
740
|
+
@secret = ENV['PURECLOUD_SECRET']
|
741
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
742
|
+
environment = "mypurecloud.com"
|
743
|
+
|
744
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
745
|
+
|
746
|
+
PureCloud.configure do |config|
|
747
|
+
config.access_token = @authToken
|
748
|
+
end
|
749
|
+
|
750
|
+
api_instance = PureCloud::AuthorizationApi.new
|
751
|
+
|
752
|
+
opts = {
|
753
|
+
page_size: 25, # Integer | Page size
|
754
|
+
page_number: 1 # Integer | Page number
|
755
|
+
}
|
756
|
+
|
757
|
+
begin
|
758
|
+
#Get all permissions.
|
759
|
+
result = api_instance.get_authorization_permissions(opts)
|
760
|
+
p result
|
761
|
+
rescue PureCloud::ApiError => e
|
762
|
+
puts "Exception when calling AuthorizationApi->get_authorization_permissions: #{e}"
|
763
|
+
end
|
764
|
+
~~~
|
765
|
+
|
766
|
+
### Parameters
|
767
|
+
|
768
|
+
Name | Type | Description | Notes
|
769
|
+
------------- | ------------- | ------------- | -------------
|
770
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
771
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
772
|
+
{: class="table table-striped"}
|
773
|
+
|
774
|
+
|
775
|
+
### Return type
|
776
|
+
|
777
|
+
[**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html)
|
778
|
+
|
779
|
+
### HTTP request headers
|
780
|
+
|
781
|
+
- **Content-Type**: application/json
|
782
|
+
- **Accept**: application/json
|
783
|
+
|
784
|
+
|
785
|
+
|
786
|
+
<a name="get_authorization_products"></a>
|
787
|
+
|
788
|
+
## -[**OrganizationProductEntityListing**](OrganizationProductEntityListing.html) get_authorization_products
|
789
|
+
|
790
|
+
|
791
|
+
|
792
|
+
Get the list of enabled products
|
793
|
+
|
794
|
+
Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
|
795
|
+
|
796
|
+
Wraps GET /api/v2/authorization/products
|
797
|
+
|
798
|
+
Requires NO permissions:
|
799
|
+
|
800
|
+
|
801
|
+
|
802
|
+
### Example
|
803
|
+
~~~ruby
|
804
|
+
# load the gem
|
805
|
+
require 'purecloudplatformclientv2'
|
806
|
+
# setup authorization
|
807
|
+
@secret = ENV['PURECLOUD_SECRET']
|
808
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
809
|
+
environment = "mypurecloud.com"
|
810
|
+
|
811
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
812
|
+
|
813
|
+
PureCloud.configure do |config|
|
814
|
+
config.access_token = @authToken
|
815
|
+
end
|
816
|
+
|
817
|
+
api_instance = PureCloud::AuthorizationApi.new
|
818
|
+
|
819
|
+
begin
|
820
|
+
#Get the list of enabled products
|
821
|
+
result = api_instance.get_authorization_products
|
822
|
+
p result
|
823
|
+
rescue PureCloud::ApiError => e
|
824
|
+
puts "Exception when calling AuthorizationApi->get_authorization_products: #{e}"
|
825
|
+
end
|
826
|
+
~~~
|
827
|
+
|
828
|
+
### Parameters
|
829
|
+
This endpoint does not need any parameter.
|
830
|
+
{: class="table table-striped"}
|
831
|
+
|
832
|
+
|
833
|
+
### Return type
|
834
|
+
|
835
|
+
[**OrganizationProductEntityListing**](OrganizationProductEntityListing.html)
|
836
|
+
|
837
|
+
### HTTP request headers
|
838
|
+
|
839
|
+
- **Content-Type**: application/json
|
840
|
+
- **Accept**: application/json
|
841
|
+
|
842
|
+
|
843
|
+
|
844
|
+
<a name="get_authorization_role"></a>
|
845
|
+
|
846
|
+
## -[**DomainOrganizationRole**](DomainOrganizationRole.html) get_authorization_role(role_id)
|
847
|
+
|
848
|
+
|
849
|
+
|
850
|
+
Get a single organization role.
|
851
|
+
|
852
|
+
Get the organization role specified by its ID.
|
853
|
+
|
854
|
+
Wraps GET /api/v2/authorization/roles/{roleId}
|
855
|
+
|
856
|
+
Requires ANY permissions:
|
857
|
+
|
858
|
+
* authorization:role:view
|
859
|
+
|
860
|
+
|
861
|
+
### Example
|
862
|
+
~~~ruby
|
863
|
+
# load the gem
|
864
|
+
require 'purecloudplatformclientv2'
|
865
|
+
# setup authorization
|
866
|
+
@secret = ENV['PURECLOUD_SECRET']
|
867
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
868
|
+
environment = "mypurecloud.com"
|
869
|
+
|
870
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
871
|
+
|
872
|
+
PureCloud.configure do |config|
|
873
|
+
config.access_token = @authToken
|
874
|
+
end
|
875
|
+
|
876
|
+
api_instance = PureCloud::AuthorizationApi.new
|
877
|
+
|
878
|
+
role_id = "role_id_example" # String | Role ID
|
879
|
+
|
880
|
+
|
881
|
+
begin
|
882
|
+
#Get a single organization role.
|
883
|
+
result = api_instance.get_authorization_role(role_id)
|
884
|
+
p result
|
885
|
+
rescue PureCloud::ApiError => e
|
886
|
+
puts "Exception when calling AuthorizationApi->get_authorization_role: #{e}"
|
887
|
+
end
|
888
|
+
~~~
|
889
|
+
|
890
|
+
### Parameters
|
891
|
+
|
892
|
+
Name | Type | Description | Notes
|
893
|
+
------------- | ------------- | ------------- | -------------
|
894
|
+
**role_id** | **String**| Role ID | |
|
895
|
+
{: class="table table-striped"}
|
896
|
+
|
897
|
+
|
898
|
+
### Return type
|
899
|
+
|
900
|
+
[**DomainOrganizationRole**](DomainOrganizationRole.html)
|
901
|
+
|
902
|
+
### HTTP request headers
|
903
|
+
|
904
|
+
- **Content-Type**: application/json
|
905
|
+
- **Accept**: application/json
|
906
|
+
|
907
|
+
|
908
|
+
|
909
|
+
<a name="get_authorization_role_comparedefault_right_role_id"></a>
|
910
|
+
|
911
|
+
## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id)
|
912
|
+
|
913
|
+
|
914
|
+
|
915
|
+
Get an org role to default role comparison comparison
|
916
|
+
|
917
|
+
Compares any organization role to a default role id and show differences
|
918
|
+
|
919
|
+
Wraps GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
|
920
|
+
|
921
|
+
Requires ANY permissions:
|
922
|
+
|
923
|
+
* authorization:role:view
|
924
|
+
|
925
|
+
|
926
|
+
### Example
|
927
|
+
~~~ruby
|
928
|
+
# load the gem
|
929
|
+
require 'purecloudplatformclientv2'
|
930
|
+
# setup authorization
|
931
|
+
@secret = ENV['PURECLOUD_SECRET']
|
932
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
933
|
+
environment = "mypurecloud.com"
|
934
|
+
|
935
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
936
|
+
|
937
|
+
PureCloud.configure do |config|
|
938
|
+
config.access_token = @authToken
|
939
|
+
end
|
940
|
+
|
941
|
+
api_instance = PureCloud::AuthorizationApi.new
|
942
|
+
|
943
|
+
left_role_id = "left_role_id_example" # String | Left Role ID
|
944
|
+
|
945
|
+
right_role_id = "right_role_id_example" # String | Right Role id
|
946
|
+
|
947
|
+
|
948
|
+
begin
|
949
|
+
#Get an org role to default role comparison comparison
|
950
|
+
result = api_instance.get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id)
|
951
|
+
p result
|
952
|
+
rescue PureCloud::ApiError => e
|
953
|
+
puts "Exception when calling AuthorizationApi->get_authorization_role_comparedefault_right_role_id: #{e}"
|
954
|
+
end
|
955
|
+
~~~
|
956
|
+
|
957
|
+
### Parameters
|
958
|
+
|
959
|
+
Name | Type | Description | Notes
|
960
|
+
------------- | ------------- | ------------- | -------------
|
961
|
+
**left_role_id** | **String**| Left Role ID | |
|
962
|
+
**right_role_id** | **String**| Right Role id | |
|
963
|
+
{: class="table table-striped"}
|
964
|
+
|
965
|
+
|
966
|
+
### Return type
|
967
|
+
|
968
|
+
[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html)
|
969
|
+
|
970
|
+
### HTTP request headers
|
971
|
+
|
972
|
+
- **Content-Type**: application/json
|
973
|
+
- **Accept**: application/json
|
974
|
+
|
975
|
+
|
976
|
+
|
977
|
+
<a name="get_authorization_role_subjectgrants"></a>
|
978
|
+
|
979
|
+
## -[**SubjectDivisionGrantsEntityListing**](SubjectDivisionGrantsEntityListing.html) get_authorization_role_subjectgrants(role_id, opts)
|
980
|
+
|
981
|
+
|
982
|
+
|
983
|
+
Get the subjects' granted divisions in the specified role.
|
984
|
+
|
985
|
+
Includes the divisions for which the subject has a grant.
|
986
|
+
|
987
|
+
Wraps GET /api/v2/authorization/roles/{roleId}/subjectgrants
|
988
|
+
|
989
|
+
Requires ANY permissions:
|
990
|
+
|
991
|
+
* authorization:role:view
|
992
|
+
|
993
|
+
|
994
|
+
### Example
|
995
|
+
~~~ruby
|
996
|
+
# load the gem
|
997
|
+
require 'purecloudplatformclientv2'
|
998
|
+
# setup authorization
|
999
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1000
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1001
|
+
environment = "mypurecloud.com"
|
1002
|
+
|
1003
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1004
|
+
|
1005
|
+
PureCloud.configure do |config|
|
1006
|
+
config.access_token = @authToken
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1010
|
+
|
1011
|
+
role_id = "role_id_example" # String | Role ID
|
1012
|
+
|
1013
|
+
opts = {
|
1014
|
+
page_size: 25, # Integer | The total page size requested
|
1015
|
+
page_number: 1, # Integer | The page number requested
|
1016
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
1017
|
+
expand: ["expand_example"], # Array<String> | variable name requested by expand list
|
1018
|
+
next_page: "next_page_example", # String | next page token
|
1019
|
+
previous_page: "previous_page_example" # String | Previous page token
|
1020
|
+
}
|
1021
|
+
|
1022
|
+
begin
|
1023
|
+
#Get the subjects' granted divisions in the specified role.
|
1024
|
+
result = api_instance.get_authorization_role_subjectgrants(role_id, opts)
|
1025
|
+
p result
|
1026
|
+
rescue PureCloud::ApiError => e
|
1027
|
+
puts "Exception when calling AuthorizationApi->get_authorization_role_subjectgrants: #{e}"
|
1028
|
+
end
|
1029
|
+
~~~
|
1030
|
+
|
1031
|
+
### Parameters
|
1032
|
+
|
1033
|
+
Name | Type | Description | Notes
|
1034
|
+
------------- | ------------- | ------------- | -------------
|
1035
|
+
**role_id** | **String**| Role ID | |
|
1036
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
1037
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
1038
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
1039
|
+
**expand** | [**Array<String>**](String.html)| variable name requested by expand list | [optional] |
|
1040
|
+
**next_page** | **String**| next page token | [optional] |
|
1041
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
1042
|
+
{: class="table table-striped"}
|
1043
|
+
|
1044
|
+
|
1045
|
+
### Return type
|
1046
|
+
|
1047
|
+
[**SubjectDivisionGrantsEntityListing**](SubjectDivisionGrantsEntityListing.html)
|
1048
|
+
|
1049
|
+
### HTTP request headers
|
1050
|
+
|
1051
|
+
- **Content-Type**: application/json
|
1052
|
+
- **Accept**: application/json
|
1053
|
+
|
1054
|
+
|
1055
|
+
|
1056
|
+
<a name="get_authorization_role_users"></a>
|
1057
|
+
|
1058
|
+
## -[**UserEntityListing**](UserEntityListing.html) get_authorization_role_users(role_id, opts)
|
1059
|
+
|
1060
|
+
|
1061
|
+
|
1062
|
+
Get a list of the users in a specified role.
|
1063
|
+
|
1064
|
+
Get an array of the UUIDs of the users in the specified role.
|
1065
|
+
|
1066
|
+
Wraps GET /api/v2/authorization/roles/{roleId}/users
|
1067
|
+
|
1068
|
+
Requires NO permissions:
|
1069
|
+
|
1070
|
+
|
1071
|
+
|
1072
|
+
### Example
|
1073
|
+
~~~ruby
|
1074
|
+
# load the gem
|
1075
|
+
require 'purecloudplatformclientv2'
|
1076
|
+
# setup authorization
|
1077
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1078
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1079
|
+
environment = "mypurecloud.com"
|
1080
|
+
|
1081
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1082
|
+
|
1083
|
+
PureCloud.configure do |config|
|
1084
|
+
config.access_token = @authToken
|
1085
|
+
end
|
1086
|
+
|
1087
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1088
|
+
|
1089
|
+
role_id = "role_id_example" # String | Role ID
|
1090
|
+
|
1091
|
+
opts = {
|
1092
|
+
page_size: 25, # Integer | Page size
|
1093
|
+
page_number: 1 # Integer | Page number
|
1094
|
+
}
|
1095
|
+
|
1096
|
+
begin
|
1097
|
+
#Get a list of the users in a specified role.
|
1098
|
+
result = api_instance.get_authorization_role_users(role_id, opts)
|
1099
|
+
p result
|
1100
|
+
rescue PureCloud::ApiError => e
|
1101
|
+
puts "Exception when calling AuthorizationApi->get_authorization_role_users: #{e}"
|
1102
|
+
end
|
1103
|
+
~~~
|
1104
|
+
|
1105
|
+
### Parameters
|
1106
|
+
|
1107
|
+
Name | Type | Description | Notes
|
1108
|
+
------------- | ------------- | ------------- | -------------
|
1109
|
+
**role_id** | **String**| Role ID | |
|
1110
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1111
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1112
|
+
{: class="table table-striped"}
|
1113
|
+
|
1114
|
+
|
1115
|
+
### Return type
|
1116
|
+
|
1117
|
+
[**UserEntityListing**](UserEntityListing.html)
|
1118
|
+
|
1119
|
+
### HTTP request headers
|
1120
|
+
|
1121
|
+
- **Content-Type**: application/json
|
1122
|
+
- **Accept**: application/json
|
1123
|
+
|
1124
|
+
|
1125
|
+
|
1126
|
+
<a name="get_authorization_roles"></a>
|
1127
|
+
|
1128
|
+
## -[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html) get_authorization_roles(opts)
|
1129
|
+
|
1130
|
+
|
1131
|
+
|
1132
|
+
Retrieve a list of all roles defined for the organization
|
1133
|
+
|
1134
|
+
|
1135
|
+
|
1136
|
+
Wraps GET /api/v2/authorization/roles
|
1137
|
+
|
1138
|
+
Requires ANY permissions:
|
1139
|
+
|
1140
|
+
* authorization:role:view
|
1141
|
+
|
1142
|
+
|
1143
|
+
### Example
|
1144
|
+
~~~ruby
|
1145
|
+
# load the gem
|
1146
|
+
require 'purecloudplatformclientv2'
|
1147
|
+
# setup authorization
|
1148
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1149
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1150
|
+
environment = "mypurecloud.com"
|
1151
|
+
|
1152
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1153
|
+
|
1154
|
+
PureCloud.configure do |config|
|
1155
|
+
config.access_token = @authToken
|
1156
|
+
end
|
1157
|
+
|
1158
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1159
|
+
|
1160
|
+
opts = {
|
1161
|
+
page_size: 25, # Integer | The total page size requested
|
1162
|
+
page_number: 1, # Integer | The page number requested
|
1163
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
1164
|
+
expand: ["expand_example"], # Array<String> | variable name requested by expand list
|
1165
|
+
next_page: "next_page_example", # String | next page token
|
1166
|
+
previous_page: "previous_page_example", # String | Previous page token
|
1167
|
+
name: "name_example", # String |
|
1168
|
+
permission: ["permission_example"], # Array<String> |
|
1169
|
+
default_role_id: ["default_role_id_example"], # Array<String> |
|
1170
|
+
user_count: true, # BOOLEAN |
|
1171
|
+
id: ["id_example"] # Array<String> | id
|
1172
|
+
}
|
1173
|
+
|
1174
|
+
begin
|
1175
|
+
#Retrieve a list of all roles defined for the organization
|
1176
|
+
result = api_instance.get_authorization_roles(opts)
|
1177
|
+
p result
|
1178
|
+
rescue PureCloud::ApiError => e
|
1179
|
+
puts "Exception when calling AuthorizationApi->get_authorization_roles: #{e}"
|
1180
|
+
end
|
1181
|
+
~~~
|
1182
|
+
|
1183
|
+
### Parameters
|
1184
|
+
|
1185
|
+
Name | Type | Description | Notes
|
1186
|
+
------------- | ------------- | ------------- | -------------
|
1187
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
1188
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
1189
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
1190
|
+
**expand** | [**Array<String>**](String.html)| variable name requested by expand list | [optional] |
|
1191
|
+
**next_page** | **String**| next page token | [optional] |
|
1192
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
1193
|
+
**name** | **String**| | [optional] |
|
1194
|
+
**permission** | [**Array<String>**](String.html)| | [optional] |
|
1195
|
+
**default_role_id** | [**Array<String>**](String.html)| | [optional] |
|
1196
|
+
**user_count** | **BOOLEAN**| | [optional] [default to true] |
|
1197
|
+
**id** | [**Array<String>**](String.html)| id | [optional] |
|
1198
|
+
{: class="table table-striped"}
|
1199
|
+
|
1200
|
+
|
1201
|
+
### Return type
|
1202
|
+
|
1203
|
+
[**OrganizationRoleEntityListing**](OrganizationRoleEntityListing.html)
|
1204
|
+
|
1205
|
+
### HTTP request headers
|
1206
|
+
|
1207
|
+
- **Content-Type**: application/json
|
1208
|
+
- **Accept**: application/json
|
1209
|
+
|
1210
|
+
|
1211
|
+
|
1212
|
+
<a name="get_authorization_subject"></a>
|
1213
|
+
|
1214
|
+
## -[**AuthzSubject**](AuthzSubject.html) get_authorization_subject(subject_id)
|
1215
|
+
|
1216
|
+
|
1217
|
+
|
1218
|
+
Returns a listing of roles and permissions for a user.
|
1219
|
+
|
1220
|
+
|
1221
|
+
|
1222
|
+
Wraps GET /api/v2/authorization/subjects/{subjectId}
|
1223
|
+
|
1224
|
+
Requires ANY permissions:
|
1225
|
+
|
1226
|
+
* authorization:grant:view
|
1227
|
+
|
1228
|
+
|
1229
|
+
### Example
|
1230
|
+
~~~ruby
|
1231
|
+
# load the gem
|
1232
|
+
require 'purecloudplatformclientv2'
|
1233
|
+
# setup authorization
|
1234
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1235
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1236
|
+
environment = "mypurecloud.com"
|
1237
|
+
|
1238
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1239
|
+
|
1240
|
+
PureCloud.configure do |config|
|
1241
|
+
config.access_token = @authToken
|
1242
|
+
end
|
1243
|
+
|
1244
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1245
|
+
|
1246
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
1247
|
+
|
1248
|
+
|
1249
|
+
begin
|
1250
|
+
#Returns a listing of roles and permissions for a user.
|
1251
|
+
result = api_instance.get_authorization_subject(subject_id)
|
1252
|
+
p result
|
1253
|
+
rescue PureCloud::ApiError => e
|
1254
|
+
puts "Exception when calling AuthorizationApi->get_authorization_subject: #{e}"
|
1255
|
+
end
|
1256
|
+
~~~
|
1257
|
+
|
1258
|
+
### Parameters
|
1259
|
+
|
1260
|
+
Name | Type | Description | Notes
|
1261
|
+
------------- | ------------- | ------------- | -------------
|
1262
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
1263
|
+
{: class="table table-striped"}
|
1264
|
+
|
1265
|
+
|
1266
|
+
### Return type
|
1267
|
+
|
1268
|
+
[**AuthzSubject**](AuthzSubject.html)
|
1269
|
+
|
1270
|
+
### HTTP request headers
|
1271
|
+
|
1272
|
+
- **Content-Type**: application/json
|
1273
|
+
- **Accept**: application/json
|
1274
|
+
|
1275
|
+
|
1276
|
+
|
1277
|
+
<a name="get_authorization_subjects_me"></a>
|
1278
|
+
|
1279
|
+
## -[**AuthzSubject**](AuthzSubject.html) get_authorization_subjects_me
|
1280
|
+
|
1281
|
+
|
1282
|
+
|
1283
|
+
Returns a listing of roles and permissions for the currently authenticated user.
|
1284
|
+
|
1285
|
+
|
1286
|
+
|
1287
|
+
Wraps GET /api/v2/authorization/subjects/me
|
1288
|
+
|
1289
|
+
Requires NO permissions:
|
1290
|
+
|
1291
|
+
|
1292
|
+
|
1293
|
+
### Example
|
1294
|
+
~~~ruby
|
1295
|
+
# load the gem
|
1296
|
+
require 'purecloudplatformclientv2'
|
1297
|
+
# setup authorization
|
1298
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1299
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1300
|
+
environment = "mypurecloud.com"
|
1301
|
+
|
1302
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1303
|
+
|
1304
|
+
PureCloud.configure do |config|
|
1305
|
+
config.access_token = @authToken
|
1306
|
+
end
|
1307
|
+
|
1308
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1309
|
+
|
1310
|
+
begin
|
1311
|
+
#Returns a listing of roles and permissions for the currently authenticated user.
|
1312
|
+
result = api_instance.get_authorization_subjects_me
|
1313
|
+
p result
|
1314
|
+
rescue PureCloud::ApiError => e
|
1315
|
+
puts "Exception when calling AuthorizationApi->get_authorization_subjects_me: #{e}"
|
1316
|
+
end
|
1317
|
+
~~~
|
1318
|
+
|
1319
|
+
### Parameters
|
1320
|
+
This endpoint does not need any parameter.
|
1321
|
+
{: class="table table-striped"}
|
1322
|
+
|
1323
|
+
|
1324
|
+
### Return type
|
1325
|
+
|
1326
|
+
[**AuthzSubject**](AuthzSubject.html)
|
1327
|
+
|
1328
|
+
### HTTP request headers
|
1329
|
+
|
1330
|
+
- **Content-Type**: application/json
|
1331
|
+
- **Accept**: application/json
|
1332
|
+
|
1333
|
+
|
1334
|
+
|
1335
|
+
<a name="get_user_roles"></a>
|
1336
|
+
|
1337
|
+
## -[**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
|
1338
|
+
|
1339
|
+
|
1340
|
+
|
1341
|
+
Returns a listing of roles and permissions for a user.
|
1342
|
+
|
1343
|
+
|
1344
|
+
|
1345
|
+
Wraps GET /api/v2/users/{userId}/roles
|
1346
|
+
|
1347
|
+
Requires ANY permissions:
|
1348
|
+
|
1349
|
+
* authorization:grant:view
|
1350
|
+
|
1351
|
+
|
1352
|
+
### Example
|
1353
|
+
~~~ruby
|
1354
|
+
# load the gem
|
1355
|
+
require 'purecloudplatformclientv2'
|
1356
|
+
# setup authorization
|
1357
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1358
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1359
|
+
environment = "mypurecloud.com"
|
1360
|
+
|
1361
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1362
|
+
|
1363
|
+
PureCloud.configure do |config|
|
1364
|
+
config.access_token = @authToken
|
1365
|
+
end
|
1366
|
+
|
1367
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1368
|
+
|
1369
|
+
user_id = "user_id_example" # String | User ID
|
1370
|
+
|
1371
|
+
|
1372
|
+
begin
|
1373
|
+
#Returns a listing of roles and permissions for a user.
|
1374
|
+
result = api_instance.get_user_roles(user_id)
|
1375
|
+
p result
|
1376
|
+
rescue PureCloud::ApiError => e
|
1377
|
+
puts "Exception when calling AuthorizationApi->get_user_roles: #{e}"
|
1378
|
+
end
|
1379
|
+
~~~
|
1380
|
+
|
1381
|
+
### Parameters
|
1382
|
+
|
1383
|
+
Name | Type | Description | Notes
|
1384
|
+
------------- | ------------- | ------------- | -------------
|
1385
|
+
**user_id** | **String**| User ID | |
|
1386
|
+
{: class="table table-striped"}
|
1387
|
+
|
1388
|
+
|
1389
|
+
### Return type
|
1390
|
+
|
1391
|
+
[**UserAuthorization**](UserAuthorization.html)
|
1392
|
+
|
1393
|
+
### HTTP request headers
|
1394
|
+
|
1395
|
+
- **Content-Type**: application/json
|
1396
|
+
- **Accept**: application/json
|
1397
|
+
|
1398
|
+
|
1399
|
+
|
1400
|
+
<a name="patch_authorization_role"></a>
|
1401
|
+
|
1402
|
+
## -[**DomainOrganizationRole**](DomainOrganizationRole.html) patch_authorization_role(role_id, body)
|
1403
|
+
|
1404
|
+
|
1405
|
+
|
1406
|
+
Patch Organization Role for needsUpdate Field
|
1407
|
+
|
1408
|
+
Patch Organization Role for needsUpdate Field
|
1409
|
+
|
1410
|
+
Wraps PATCH /api/v2/authorization/roles/{roleId}
|
1411
|
+
|
1412
|
+
Requires ANY permissions:
|
1413
|
+
|
1414
|
+
* admin
|
1415
|
+
* role_manager
|
1416
|
+
* authorization:role:edit
|
1417
|
+
|
1418
|
+
|
1419
|
+
### Example
|
1420
|
+
~~~ruby
|
1421
|
+
# load the gem
|
1422
|
+
require 'purecloudplatformclientv2'
|
1423
|
+
# setup authorization
|
1424
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1425
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1426
|
+
environment = "mypurecloud.com"
|
1427
|
+
|
1428
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1429
|
+
|
1430
|
+
PureCloud.configure do |config|
|
1431
|
+
config.access_token = @authToken
|
1432
|
+
end
|
1433
|
+
|
1434
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1435
|
+
|
1436
|
+
role_id = "role_id_example" # String | Role ID
|
1437
|
+
|
1438
|
+
body = PureCloud::DomainOrganizationRole.new # DomainOrganizationRole | Organization role
|
1439
|
+
|
1440
|
+
|
1441
|
+
begin
|
1442
|
+
#Patch Organization Role for needsUpdate Field
|
1443
|
+
result = api_instance.patch_authorization_role(role_id, body)
|
1444
|
+
p result
|
1445
|
+
rescue PureCloud::ApiError => e
|
1446
|
+
puts "Exception when calling AuthorizationApi->patch_authorization_role: #{e}"
|
1447
|
+
end
|
1448
|
+
~~~
|
1449
|
+
|
1450
|
+
### Parameters
|
1451
|
+
|
1452
|
+
Name | Type | Description | Notes
|
1453
|
+
------------- | ------------- | ------------- | -------------
|
1454
|
+
**role_id** | **String**| Role ID | |
|
1455
|
+
**body** | [**DomainOrganizationRole**](DomainOrganizationRole.html)| Organization role | |
|
1456
|
+
{: class="table table-striped"}
|
1457
|
+
|
1458
|
+
|
1459
|
+
### Return type
|
1460
|
+
|
1461
|
+
[**DomainOrganizationRole**](DomainOrganizationRole.html)
|
1462
|
+
|
1463
|
+
### HTTP request headers
|
1464
|
+
|
1465
|
+
- **Content-Type**: application/json
|
1466
|
+
- **Accept**: application/json
|
1467
|
+
|
1468
|
+
|
1469
|
+
|
1470
|
+
<a name="post_authorization_division_object"></a>
|
1471
|
+
|
1472
|
+
## - post_authorization_division_object(division_id, object_type, body)
|
1473
|
+
|
1474
|
+
|
1475
|
+
|
1476
|
+
Assign a list of objects to a division
|
1477
|
+
|
1478
|
+
Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]
|
1479
|
+
|
1480
|
+
Wraps POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}
|
1481
|
+
|
1482
|
+
Requires NO permissions:
|
1483
|
+
|
1484
|
+
|
1485
|
+
|
1486
|
+
### Example
|
1487
|
+
~~~ruby
|
1488
|
+
# load the gem
|
1489
|
+
require 'purecloudplatformclientv2'
|
1490
|
+
# setup authorization
|
1491
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1492
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1493
|
+
environment = "mypurecloud.com"
|
1494
|
+
|
1495
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1496
|
+
|
1497
|
+
PureCloud.configure do |config|
|
1498
|
+
config.access_token = @authToken
|
1499
|
+
end
|
1500
|
+
|
1501
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1502
|
+
|
1503
|
+
division_id = "division_id_example" # String | Division ID
|
1504
|
+
|
1505
|
+
object_type = "object_type_example" # String | The type of the objects. Must be one of the valid object types
|
1506
|
+
|
1507
|
+
body = [PureCloud::Array<String>.new] # Array<String> | Object Id List
|
1508
|
+
|
1509
|
+
|
1510
|
+
begin
|
1511
|
+
#Assign a list of objects to a division
|
1512
|
+
api_instance.post_authorization_division_object(division_id, object_type, body)
|
1513
|
+
rescue PureCloud::ApiError => e
|
1514
|
+
puts "Exception when calling AuthorizationApi->post_authorization_division_object: #{e}"
|
1515
|
+
end
|
1516
|
+
~~~
|
1517
|
+
|
1518
|
+
### Parameters
|
1519
|
+
|
1520
|
+
Name | Type | Description | Notes
|
1521
|
+
------------- | ------------- | ------------- | -------------
|
1522
|
+
**division_id** | **String**| Division ID | |
|
1523
|
+
**object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER |
|
1524
|
+
**body** | **Array<String>**| Object Id List | |
|
1525
|
+
{: class="table table-striped"}
|
1526
|
+
|
1527
|
+
|
1528
|
+
### Return type
|
1529
|
+
|
1530
|
+
nil (empty response body)
|
1531
|
+
|
1532
|
+
### HTTP request headers
|
1533
|
+
|
1534
|
+
- **Content-Type**: application/json
|
1535
|
+
- **Accept**: application/json
|
1536
|
+
|
1537
|
+
|
1538
|
+
|
1539
|
+
<a name="post_authorization_divisions"></a>
|
1540
|
+
|
1541
|
+
## -[**AuthzDivision**](AuthzDivision.html) post_authorization_divisions(body)
|
1542
|
+
|
1543
|
+
|
1544
|
+
|
1545
|
+
Create a division.
|
1546
|
+
|
1547
|
+
|
1548
|
+
|
1549
|
+
Wraps POST /api/v2/authorization/divisions
|
1550
|
+
|
1551
|
+
Requires ALL permissions:
|
1552
|
+
|
1553
|
+
* authorization:division:add
|
1554
|
+
* authorization:grant:add
|
1555
|
+
|
1556
|
+
|
1557
|
+
### Example
|
1558
|
+
~~~ruby
|
1559
|
+
# load the gem
|
1560
|
+
require 'purecloudplatformclientv2'
|
1561
|
+
# setup authorization
|
1562
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1563
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1564
|
+
environment = "mypurecloud.com"
|
1565
|
+
|
1566
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1567
|
+
|
1568
|
+
PureCloud.configure do |config|
|
1569
|
+
config.access_token = @authToken
|
1570
|
+
end
|
1571
|
+
|
1572
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1573
|
+
|
1574
|
+
body = PureCloud::AuthzDivision.new # AuthzDivision | Division
|
1575
|
+
|
1576
|
+
|
1577
|
+
begin
|
1578
|
+
#Create a division.
|
1579
|
+
result = api_instance.post_authorization_divisions(body)
|
1580
|
+
p result
|
1581
|
+
rescue PureCloud::ApiError => e
|
1582
|
+
puts "Exception when calling AuthorizationApi->post_authorization_divisions: #{e}"
|
1583
|
+
end
|
1584
|
+
~~~
|
1585
|
+
|
1586
|
+
### Parameters
|
1587
|
+
|
1588
|
+
Name | Type | Description | Notes
|
1589
|
+
------------- | ------------- | ------------- | -------------
|
1590
|
+
**body** | [**AuthzDivision**](AuthzDivision.html)| Division | |
|
1591
|
+
{: class="table table-striped"}
|
1592
|
+
|
1593
|
+
|
1594
|
+
### Return type
|
1595
|
+
|
1596
|
+
[**AuthzDivision**](AuthzDivision.html)
|
1597
|
+
|
1598
|
+
### HTTP request headers
|
1599
|
+
|
1600
|
+
- **Content-Type**: application/json
|
1601
|
+
- **Accept**: application/json
|
1602
|
+
|
1603
|
+
|
1604
|
+
|
1605
|
+
<a name="post_authorization_role"></a>
|
1606
|
+
|
1607
|
+
## - post_authorization_role(role_id, body)
|
1608
|
+
|
1609
|
+
|
1610
|
+
|
1611
|
+
Bulk-grant subjects and divisions with an organization role.
|
1612
|
+
|
1613
|
+
|
1614
|
+
|
1615
|
+
Wraps POST /api/v2/authorization/roles/{roleId}
|
1616
|
+
|
1617
|
+
Requires ANY permissions:
|
1618
|
+
|
1619
|
+
* authorization:grant:add
|
1620
|
+
|
1621
|
+
|
1622
|
+
### Example
|
1623
|
+
~~~ruby
|
1624
|
+
# load the gem
|
1625
|
+
require 'purecloudplatformclientv2'
|
1626
|
+
# setup authorization
|
1627
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1628
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1629
|
+
environment = "mypurecloud.com"
|
1630
|
+
|
1631
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1632
|
+
|
1633
|
+
PureCloud.configure do |config|
|
1634
|
+
config.access_token = @authToken
|
1635
|
+
end
|
1636
|
+
|
1637
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1638
|
+
|
1639
|
+
role_id = "role_id_example" # String | Role ID
|
1640
|
+
|
1641
|
+
body = PureCloud::SubjectDivisions.new # SubjectDivisions | Subjects and Divisions
|
1642
|
+
|
1643
|
+
|
1644
|
+
begin
|
1645
|
+
#Bulk-grant subjects and divisions with an organization role.
|
1646
|
+
api_instance.post_authorization_role(role_id, body)
|
1647
|
+
rescue PureCloud::ApiError => e
|
1648
|
+
puts "Exception when calling AuthorizationApi->post_authorization_role: #{e}"
|
1649
|
+
end
|
1650
|
+
~~~
|
1651
|
+
|
1652
|
+
### Parameters
|
1653
|
+
|
1654
|
+
Name | Type | Description | Notes
|
1655
|
+
------------- | ------------- | ------------- | -------------
|
1656
|
+
**role_id** | **String**| Role ID | |
|
1657
|
+
**body** | [**SubjectDivisions**](SubjectDivisions.html)| Subjects and Divisions | |
|
1658
|
+
{: class="table table-striped"}
|
1659
|
+
|
1660
|
+
|
1661
|
+
### Return type
|
1662
|
+
|
1663
|
+
nil (empty response body)
|
1664
|
+
|
1665
|
+
### HTTP request headers
|
1666
|
+
|
1667
|
+
- **Content-Type**: application/json
|
1668
|
+
- **Accept**: application/json
|
1669
|
+
|
1670
|
+
|
1671
|
+
|
1672
|
+
<a name="post_authorization_role_comparedefault_right_role_id"></a>
|
1673
|
+
|
1674
|
+
## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body)
|
1675
|
+
|
1676
|
+
|
1677
|
+
|
1678
|
+
Get an unsaved org role to default role comparison
|
1679
|
+
|
1680
|
+
Allows users to compare their existing roles in an unsaved state to its default role
|
1681
|
+
|
1682
|
+
Wraps POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
|
1683
|
+
|
1684
|
+
Requires ANY permissions:
|
1685
|
+
|
1686
|
+
* authorization:role:view
|
736
1687
|
|
737
1688
|
|
738
1689
|
### Example
|
@@ -920,6 +1871,148 @@ Name | Type | Description | Notes
|
|
920
1871
|
|
921
1872
|
|
922
1873
|
|
1874
|
+
<a name="post_authorization_subject_division_role"></a>
|
1875
|
+
|
1876
|
+
## - post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
|
1877
|
+
|
1878
|
+
|
1879
|
+
|
1880
|
+
Make a grant of a role in a division
|
1881
|
+
|
1882
|
+
|
1883
|
+
|
1884
|
+
Wraps POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
|
1885
|
+
|
1886
|
+
Requires ANY permissions:
|
1887
|
+
|
1888
|
+
* authorization:grant:add
|
1889
|
+
|
1890
|
+
|
1891
|
+
### Example
|
1892
|
+
~~~ruby
|
1893
|
+
# load the gem
|
1894
|
+
require 'purecloudplatformclientv2'
|
1895
|
+
# setup authorization
|
1896
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1897
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1898
|
+
environment = "mypurecloud.com"
|
1899
|
+
|
1900
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1901
|
+
|
1902
|
+
PureCloud.configure do |config|
|
1903
|
+
config.access_token = @authToken
|
1904
|
+
end
|
1905
|
+
|
1906
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1907
|
+
|
1908
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
1909
|
+
|
1910
|
+
division_id = "division_id_example" # String | the id of the division to which to make the grant
|
1911
|
+
|
1912
|
+
role_id = "role_id_example" # String | the id of the role to grant
|
1913
|
+
|
1914
|
+
opts = {
|
1915
|
+
subject_type: "PC_USER" # String | what the type of the subject is, PC_GROUP or PC_USER
|
1916
|
+
}
|
1917
|
+
|
1918
|
+
begin
|
1919
|
+
#Make a grant of a role in a division
|
1920
|
+
api_instance.post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
|
1921
|
+
rescue PureCloud::ApiError => e
|
1922
|
+
puts "Exception when calling AuthorizationApi->post_authorization_subject_division_role: #{e}"
|
1923
|
+
end
|
1924
|
+
~~~
|
1925
|
+
|
1926
|
+
### Parameters
|
1927
|
+
|
1928
|
+
Name | Type | Description | Notes
|
1929
|
+
------------- | ------------- | ------------- | -------------
|
1930
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
1931
|
+
**division_id** | **String**| the id of the division to which to make the grant | |
|
1932
|
+
**role_id** | **String**| the id of the role to grant | |
|
1933
|
+
**subject_type** | **String**| what the type of the subject is, PC_GROUP or PC_USER | [optional] [default to PC_USER] |
|
1934
|
+
{: class="table table-striped"}
|
1935
|
+
|
1936
|
+
|
1937
|
+
### Return type
|
1938
|
+
|
1939
|
+
nil (empty response body)
|
1940
|
+
|
1941
|
+
### HTTP request headers
|
1942
|
+
|
1943
|
+
- **Content-Type**: application/json
|
1944
|
+
- **Accept**: application/json
|
1945
|
+
|
1946
|
+
|
1947
|
+
|
1948
|
+
<a name="put_authorization_division"></a>
|
1949
|
+
|
1950
|
+
## -[**AuthzDivision**](AuthzDivision.html) put_authorization_division(division_id, body)
|
1951
|
+
|
1952
|
+
|
1953
|
+
|
1954
|
+
Update a division.
|
1955
|
+
|
1956
|
+
|
1957
|
+
|
1958
|
+
Wraps PUT /api/v2/authorization/divisions/{divisionId}
|
1959
|
+
|
1960
|
+
Requires ANY permissions:
|
1961
|
+
|
1962
|
+
* authorization:division:edit
|
1963
|
+
|
1964
|
+
|
1965
|
+
### Example
|
1966
|
+
~~~ruby
|
1967
|
+
# load the gem
|
1968
|
+
require 'purecloudplatformclientv2'
|
1969
|
+
# setup authorization
|
1970
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1971
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1972
|
+
environment = "mypurecloud.com"
|
1973
|
+
|
1974
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1975
|
+
|
1976
|
+
PureCloud.configure do |config|
|
1977
|
+
config.access_token = @authToken
|
1978
|
+
end
|
1979
|
+
|
1980
|
+
api_instance = PureCloud::AuthorizationApi.new
|
1981
|
+
|
1982
|
+
division_id = "division_id_example" # String | Division ID
|
1983
|
+
|
1984
|
+
body = PureCloud::AuthzDivision.new # AuthzDivision | Updated division data
|
1985
|
+
|
1986
|
+
|
1987
|
+
begin
|
1988
|
+
#Update a division.
|
1989
|
+
result = api_instance.put_authorization_division(division_id, body)
|
1990
|
+
p result
|
1991
|
+
rescue PureCloud::ApiError => e
|
1992
|
+
puts "Exception when calling AuthorizationApi->put_authorization_division: #{e}"
|
1993
|
+
end
|
1994
|
+
~~~
|
1995
|
+
|
1996
|
+
### Parameters
|
1997
|
+
|
1998
|
+
Name | Type | Description | Notes
|
1999
|
+
------------- | ------------- | ------------- | -------------
|
2000
|
+
**division_id** | **String**| Division ID | |
|
2001
|
+
**body** | [**AuthzDivision**](AuthzDivision.html)| Updated division data | |
|
2002
|
+
{: class="table table-striped"}
|
2003
|
+
|
2004
|
+
|
2005
|
+
### Return type
|
2006
|
+
|
2007
|
+
[**AuthzDivision**](AuthzDivision.html)
|
2008
|
+
|
2009
|
+
### HTTP request headers
|
2010
|
+
|
2011
|
+
- **Content-Type**: application/json
|
2012
|
+
- **Accept**: application/json
|
2013
|
+
|
2014
|
+
|
2015
|
+
|
923
2016
|
<a name="put_authorization_role"></a>
|
924
2017
|
|
925
2018
|
## -[**DomainOrganizationRole**](DomainOrganizationRole.html) put_authorization_role(role_id, body)
|