Skip to content

Tenant object fields

Example of JSON-formatted tenant instance:

{
    "tenant":
    {
        "tenant_id": "34c7f1f6-9201-11e5-a739-e03f497dbdff",
        "name": "Flexus",
        "timezone": null,
        "encrypt_data": null,
        "fieldset_licensing":
        {
            "recording_seats": null,
            "screen_recording_seats": null,
            "monitoring_seats": null,
            "evaluation_seats": 50,
            "speech_analytics": 10
        },
        "fieldset_associate_calls":
        {
            "extension_uniqueness": "systemwide",

            "associate_calls": "broadworks_group",
            "associate_calls_condition": "BroadWorks-serviceProviderID = \"FlexusProvider\" AND BroadWorks-groupID = \"FlexusGroup\"",
            "broadworks_sp_id": "FlexusProvider",
            "broadworks_group_id": "FlexusGroup",
            "sip_uri_host": "",
            "cisco_partition": "",
            "metaswitch_system": "",
            "metaswitch_group": "",

            "record_unknown_users": "record",

            "auto_provision": true,
            "provision_role_id": "34cafffe-9201-11e5-b516-e03f497dbdff",
            "provision_group_id": "47f53fcc-9201-11e5-b4ef-e03f497dbdff",
        }
    }
}
Field Type Description
name string Tenant name.
tenant_id UUID Unique ID of tenant assigned by MiaRec when tenant is created.
timezone string

Default timezone setting for all users within this tenant. This value is used for displaying date/time values to users.

If not specified, then system default timezone is used.

Note, the timezone setting may be overriden on group and/or user level.
encrypt_data boolean If true, then audio files for this tenant will be encrypted using tenant's unique public key.
fieldset_licensing dictionary A group of licensing-related settings. See below.
fieldset_associate_calls dictionary A group of auto-provision settings. See below.

Fieldset "fieldset_licensing"

This section configures a license allocation for tenant.

For any individual license type, it is possible to explicitly pre-allocate a particular number of licenses to tenant (starting from 0). Or set to null to use a dynamic license allocation, when tenant is being allocated as many licenses are it has users requiring such license. Licenses are allocated from a global license pool.

Field Type Description
recording_seats integer Numeric value specifying how many licenses are allocated to that tenant or null.
recording_sessions integer Numeric value specifying how many licenses are allocated to that tenant or null.
monitoring_seats integer Numeric value specifying how many licenses are allocated to that tenant or null.
evaluation_seats integer Numeric value specifying how many licenses are allocated to that tenant or null.

Fieldset "fieldset_associate_calls"

Field Type Description
extension_uniqueness string

This setting specifies if extensions within tenant should be system-wide unique or not.

Supported values:

  • systemwide - Extensions have to be unique system-wide
  • tenant - Extensions have to be unique within tenant account only. This means that the same extension may appear in multiple tenants.
extension_uniqueness string This setting specifies if extensions within tenant should be system-wide unique or not.
associate_calls string

This setting specifies how to distinguish call recordings of one tenant from another. Such setting is especially useful when different tenant may have ovelapping extensions.

Supported values:

  • extension - Associate calls with tenant if they match to user's extension
  • broadworks_group - Associate calls with tenant if they match to particular Broadworks Service Provider ID and Group ID (see fields broadworks_sp_id and broadworks_group_id)
  • metaswitch_group - Associate calls with tenant if they match to particular Metaswitch System Name and Group Name (see fields metaswitch_system and metaswitch_group)
  • cisco_partition - Associate calls with tenant if they match to particular Cisco Partition (see field cisco_partition)
  • sip_uri_host - Associate calls with tenant if SIP URI host part matches to particular value (see field sip_uri_host)
  • condition - Associate calls with tenant if they match to custom condition (see field associate_calls_condition).
associate_calls_condition string

Recording filter condition.

Format of this field is described here, but in 99% you can do the following: login to MiaRec web-portal and create a reference tenant account with paricular values. When you save it, the condition field will be populated automatically. Then you can rely on the same format when creating tenant accounts via REST API.

Note, this field is ignored when associate_calls is equal to extension
broadworks_sp_id string

Broadworks Service Provider ID.

Note, this field is ignored when associate_calls is not equal to broadworks_group
broadworks_group_id string

Broadworks Group ID.

Note, this field is ignored when associate_calls is not equal to broadworks_group
metaswitch_system string

Metaswitch System Name.

Note, this field is ignored when associate_calls is not equal to metaswitch_group
metaswitch_group string

Metaswitch Group Name.

Note, this field is ignored when associate_calls is not equal to metaswitch_group
cisco_partition string

Cisco Partition name.

Note, this field is ignored when associate_calls is not equal to cisco_partition
sip_uri_host string

SIP URI host part.

Note, this field is ignored when associate_calls is not equal to sip_uri_host
record_unknown_users string

This setting specifies default rule for call recordings, which match to this tenant, but do not match to any of pre-configured users.

Supported values:

  • record - Record such calls and store them within tenant account. Tenant administrators may access these recordings on "Not assigned to users" page. Such recordings may be associated to users at later time. See also field auto_provision below.
  • ignore - Ignore such calls
auto_provision string

This setting specifies if user auto-provisioning is enabled for this tenant.

Note, auto-provisioning is activated only when record_unknown_users setting is equal to record.

How it works: When call for unknown user is detected and auto-provisioning is enabled, then MiaRec creates automatically new user account inside the specified group (see field provision_group_id) and with specified role (see field provision_role_id).
provision_group_id UUID ID of group, inside which an auto-provisioned user account will be created.
provision_role_id UUID ID of role, which will be assigned to newly created users.