wxc_sdk.person_settings.feature_access package

class wxc_sdk.person_settings.feature_access.FeatureAccessApi(*, session: RestSession, base: str = None)

Bases: ApiChild

End user Feature Access API

read_default() → FeatureAccessSettings

Read Default Feature Access Settings for Person

Read the default feature access configuration for users in the organization. It allows administrators to review the baseline feature availability settings that will be applied to new users by default, ensuring consistency in user experience and policy enforcement.

This API is part of the organizational-level user configuration management for feature access. It is used to define the default settings that control which Webex features are enabled or disabled when users are provisioned. In Control Hub, this corresponds to the “Default User Settings” under Calling or Telephony, providing centralized control over user capabilities across the organization.

To call this API, an administrator must use a full, or read-only administrator auth token with the spark-admin:telephony_config_read scope.

Return type:

FeatureAccessSettings

update_default(settings: FeatureAccessSettings)

Update Default Person Feature Access Configuration

Updates the default feature access configuration for users in the organization. It allows administrators to modify the baseline settings that determine which Webex features are enabled or disabled for users by default, ensuring new users are provisioned with consistent access controls.

This API is part of the organization-level user configuration management for feature access. It supports defining and updating default settings that apply automatically to all newly onboarded users. In Control Hub, this corresponds to the “Default User Settings” section for Calling or Telephony, enabling centralized and scalable configuration of user capabilities.

To use this API, an administrator must authenticate with a full, or device administrator auth token. The token must include the spark-admin:telephony_config_write scope.

Parameters:

settings (FeatureAccessSettings) – The feature access settings to be updated.

Return type:

None

read(person_id: str) → UserFeatureAccessSettings

Read Feature Access Settings for a Person

Read the feature access configuration for the current user within the organization. It allows administrators to read the telephony settings, including device and location configurations, specific to that user’s role and access privileges. This API is useful for managing and verifying user-specific feature access within the broader telephony system.

The feature is part of the organization’s telephony configuration management. It provides insight into the settings and permissions that control how telephony services are assigned and configured for individual users. This functionality is available through the Control Hub and allows for the management of user access to various telephony-related features.

To access this API, the user must possess a full, or read-only administrator role. The authentication token used must include the spark-admin:telephony_config_read scope, granting the necessary permissions to read the telephony configuration for the user in question.

Parameters:

person_id (str) – User ID of the Organization.

Return type:

UserFeatureAccessSettings

update(person_id: str, settings: FeatureAccessSettings)

Update a Person’s Feature Access Configuration

Update the feature access configuration for the current user within the organization. It enables administrators to modify the telephony settings, including device and location configurations, specific to the user’s role and access privileges. This API is useful for making adjustments to user-specific feature access within the telephony system.

The feature is part of the organization’s telephony configuration management. It provides control over the settings and permissions that govern how telephony services are assigned and configured for individual users. This functionality is available through the Control Hub and enables the modification of user access to various telephony-related features.

To use this API, an administrator must authenticate with a full, or device administrator auth token. The authentication token used must include the spark-admin:telephony_config_write scope, granting the necessary permissions to update the telephony configuration for the user in question.

Parameters:

• person_id (str) – User ID of the Organization.

• settings (FeatureAccessSettings) – The feature access settings to be updated.

Return type:

None

reset(person_id: str)

Reset a Person’s Feature Access Configuration to the Organization’s Default Settings

Reset of a user’s feature access configuration to the organization’s default settings. It ensures that any specific feature configurations set by an administrator for an individual user are overridden and replaced with the global configuration of the organization. This process helps to maintain consistency in feature access across all users, especially when administrators want to ensure that a user is subject to the organization’s global settings rather than personalized settings.

The overall feature, managed through the organization’s Control Hub, involves the configuration and customization of feature access for users. Administrators can tailor these settings to individual users based on their roles or needs, but sometimes a global reset to the default configuration is necessary. The reset API simplifies this by programmatically resetting a user’s feature access, which can be crucial when managing large teams or updating organizational policies that affect user privileges across multiple devices or locations.

To use this API, an administrator must authenticate with a full, or device administrator auth token. This ensures the individual has the necessary privileges to make changes to user configurations. Furthermore, the authentication token used must include the spark-admin:telephony_config_write scope, which grants the required permissions to modify the telephony configuration for the user. This combination of roles and scopes ensures that only authorized administrators can reset the feature access configuration.

Parameters:

person_id (str) – User ID of the Organization.

Return type:

None

base = 'telephony'

class wxc_sdk.person_settings.feature_access.FeatureAccessSettings(*, anonymousCallRejection: FeatureAccessLevel | None = None, bargeIn: FeatureAccessLevel | None = None, blockCallerId: FeatureAccessLevel | None = None, callForwarding: FeatureAccessLevel | None = None, callWaiting: FeatureAccessLevel | None = None, callNotify: FeatureAccessLevel | None = None, connectedLineIdentity: FeatureAccessLevel | None = None, executive: FeatureAccessLevel | None = None, hoteling: FeatureAccessLevel | None = None, priorityAlert: FeatureAccessLevel | None = None, selectivelyAcceptCalls: FeatureAccessLevel | None = None, selectivelyRejectCalls: FeatureAccessLevel | None = None, selectivelyForwardCalls: FeatureAccessLevel | None = None, sequentialRing: FeatureAccessLevel | None = None, simultaneousRing: FeatureAccessLevel | None = None, singleNumberReach: FeatureAccessLevel | None = None, voicemail: FeatureAccessLevel | None = None, sendCallsToVoicemail: FeatureAccessLevel | None = None, voicemailEmailCopy: FeatureAccessLevel | None = None, voicemailFaxMessaging: FeatureAccessLevel | None = None, voicemailMessageStorage: FeatureAccessLevel | None = None, voicemailNotifications: FeatureAccessLevel | None = None, voicemailTransferNumber: FeatureAccessLevel | None = None, generateActivationCode: FeatureAccessLevel | None = None, voicemailDownload: FeatureAccessLevel | None = None, **extra_data: Any)

Bases: ApiModel

anonymous_call_rejection: FeatureAccessLevel | None

Set whether end users have access to make changes to their Anonymous call rejection feature via User Hub, or other clients (Webex, IP phone, etc.).

barge_in: FeatureAccessLevel | None

Set whether end users have access to make changes to their Barge In feature via User Hub, or other clients (Webex, IP phone, etc.).

block_caller_id: FeatureAccessLevel | None

Set whether end users have access to make changes to their Block caller ID feature via User Hub, or other clients (Webex, IP phone, etc.).

call_forwarding: FeatureAccessLevel | None

Set whether end users have access to make changes to their Call forwarding feature via User Hub, or other clients (Webex, IP phone, etc.).

call_waiting: FeatureAccessLevel | None

Set whether end users have access to make changes to their Call waiting feature via User Hub, or other clients (Webex, IP phone, etc.).

call_notify: FeatureAccessLevel | None

Set whether end users have access to make changes to their Call notify feature via User Hub, or other clients (Webex, IP phone, etc.).

connected_line_identity: FeatureAccessLevel | None

Set whether end users have access to make changes to their Connected line identity feature via User Hub, or other clients (Webex, IP phone, etc.).

executive: FeatureAccessLevel | None

Set whether end users have access to make changes to their Executive/Executive assistant feature via User Hub, or other clients (Webex, IP phone, etc.).

hoteling: FeatureAccessLevel | None

Set whether end users have access to make changes to their Hoteling feature via User Hub, or other clients (Webex, IP phone, etc.).

priority_alert: FeatureAccessLevel | None

Set whether end users have access to make changes to their Priority alert feature via User Hub, or other clients (Webex, IP phone, etc.).

selectively_accept_calls: FeatureAccessLevel | None

Set whether end users have access to make changes to their Selectively accept calls feature via User Hub, or other clients (Webex, IP phone, etc.).

selectively_reject_calls: FeatureAccessLevel | None

Set whether end users have access to make changes to their Selectively reject calls feature via User Hub, or other clients (Webex, IP phone, etc.).

selectively_forward_calls: FeatureAccessLevel | None

Set whether end users have access to make changes to their Selectively forward calls feature via User Hub, or other clients (Webex, IP phone, etc.).

sequential_ring: FeatureAccessLevel | None

Set whether end users have access to make changes to their Sequential ring feature via User Hub, or other clients (Webex, IP phone, etc.).

simultaneous_ring: FeatureAccessLevel | None

Set whether end users have access to make changes to their Simultaneous ring feature via User Hub, or other clients (Webex, IP phone, etc.).

single_number_reach: FeatureAccessLevel | None

Set whether end users have access to make changes to their Single number reach feature via User Hub, or other clients (Webex, IP phone, etc.).

voicemail: FeatureAccessLevel | None

Set whether end users have access to make changes to their Voicemail feature feature via User Hub, or other clients (Webex, IP phone, etc.).

send_calls_to_voicemail: FeatureAccessLevel | None

Set whether end users have access to make changes to their Send calls to voicemail feature via User Hub, or other clients (Webex, IP phone, etc.).

voicemail_email_copy: FeatureAccessLevel | None

Set whether end users have access to make changes to their Email a copy of the voicemail message feature via User Hub, or other clients (Webex, IP phone, etc.).

voicemail_fax_messaging: FeatureAccessLevel | None

Set whether end users have access to make changes to their Fax messaging feature via User Hub, or other clients (Webex, IP phone, etc.).

voicemail_message_storage: FeatureAccessLevel | None

Set whether end users have access to make changes to their Message storage feature via User Hub, or other clients (Webex, IP phone, etc.).

voicemail_notifications: FeatureAccessLevel | None

Set whether end users have access to make changes to their Notifications feature via User Hub, or other clients (Webex, IP phone, etc.).

voicemail_transfer_number: FeatureAccessLevel | None

Set whether end users have access to make changes to their Transfer on ‘0’ to another number. feature via User Hub, or other clients (Webex, IP phone, etc.).

generate_activation_code: FeatureAccessLevel | None

Set whether end users have access to make changes to their Allow End User to Generate Activation Codes & Delete their Phones feature via User Hub, or other clients (Webex, IP phone, etc.).

voicemail_download: FeatureAccessLevel | None

Set whether end users have access to download voicemail via User Hub, or other clients (Webex, etc.).

class wxc_sdk.person_settings.feature_access.FeatureAccessLevel(*values)

Bases: str, SafeEnum

An enumeration.

full_access = 'FULL_ACCESS'

User has full access.

no_access = 'NO_ACCESS'

User does not have access.

class wxc_sdk.person_settings.feature_access.UserFeatureAccessSettings(*, userOrgSettingsPermissionEnabled: bool | None = None, userSettingsPermissions: FeatureAccessSettings | None = None, **extra_data: Any)

Bases: ApiModel

user_org_settings_permission_enabled: bool | None

Set whether end users have organization’s settings enabled for the user.

user_settings_permissions: FeatureAccessSettings | None