User object fields

Example of a user object:

{
    "user": {
        "user_id": "61e6e6b0-f147-11e5-b8b3-e03f497dbdff",
        "tenant_id": "34c7f1f6-9201-11e5-a739-e03f497dbdff",
        "name": "John Smith",
        "is_active": true,
        "email": "john.smith@example.com",
        "timezone": "America/Los_Angeles",
        "language": "en_US",
        "groups": ["47f53fcc-9201-11e5-b4ef-e03f497dbdff"],
        "group_id": "47f53fcc-9201-11e5-b4ef-e03f497dbdff",
        "role_id": "5b139cee-f13a-11e5-9615-e03f497dbdff",
        "managed_tenants": [],
        "managed_groups": [
            "34cbea90-9201-11e5-a932-e03f497dbdff",
            "34e1c1ee-9201-11e5-96a0-e03f497dbdff"
        ],
        "fieldset_login": {
            "can_login": true,
            "login": "j.smith",
            "authenticate_type": "password",
            "must_change_password": false,
            "require_2fa": false,
            "valid_till": "2027-10-01T00:00:00-07:00"
        },
        "fieldset_recording": {
            "record": "always",
            "on_demand_default": null,
            "record_direction": ["in", "out"],
            "extensions": ["12444003002"],
            "record_announcement": null,
            "confidential": false
        },
        "fieldset_screen_recording": {
            "screen_recording_login": "DOMAIN\\j.smith"
        },
        "fieldset_phone_services": {
            "phone_pin": null
        },
        "fieldset_licensing": {
            "recording_seat": true,
            "screen_recording_seat": false,
            "monitoring_seat": true,
            "evaluation_seat": false,
            "speech_analytics": true,
            "speech_analytics_license_type": "advanced"
        }
    }
}

Some sections are returned, and accepted in requests, only when the role of the API user has the corresponding Users permission: role_id and managed_tenants (Role settings), managed_groups (Managed groups settings), fieldset_recording (Recording settings), fieldset_screen_recording (Screen recording settings), fieldset_login and fieldset_phone_services (Web portal access settings), and fieldset_licensing (Licenses settings).

Attributes

Attribute	Type	Description
`user_id`	UUID	Unique ID of the user, assigned by MiaRec when the user is created. Read-only.
`tenant_id`	UUID	ID of the tenant the user belongs to. Available only when multi-tenancy is enabled. Read-only after creation; set through `group_id` or `groups` on creation.
name	string	User name. Required. 1 to 64 characters, unique within the user's groups.
`is_active`	boolean	When `false`, the user is disabled: sign-in is not permitted and recording settings are ignored. Default `true`.
email	string	Email address.
timezone	string	Time zone for displaying date and time values in the web portal, for example `America/Los_Angeles`. When empty, the time zone of the group is used.
language	string	User interface language, for example `en_US`. When empty, the default language is used.
groups	list	IDs of the groups the user is a member of.
`group_id`	UUID	ID of the first group of the user. Deprecated, use `groups` instead. Accepted in requests for backward compatibility.
`role_id`	UUID	ID of the role. Required on creation.
`managed_tenants`	list	IDs of the tenants managed by the user. Relevant only for a role with the Selected Tenants access scope.
`managed_groups`	list	IDs of the groups managed by the user. Relevant only for a role with the Selected Groups access scope.
`fieldset_login`	dictionary	Web portal access settings. See Fieldset "fieldset_login".
`fieldset_recording`	dictionary	Recording settings. See Fieldset "fieldset_recording".
`fieldset_screen_recording`	dictionary	Screen recording settings. See Fieldset "fieldset_screen_recording".
`fieldset_phone_services`	dictionary	Phone softkey services settings. See Fieldset "fieldset_phone_services".
`fieldset_licensing`	dictionary	License allocation. See Fieldset "fieldset_licensing".

Fieldset "fieldset_login"

Attribute	Type	Description
`can_login`	boolean	Whether the user can sign in to the web portal. Default `false`. Must be `true` for the other attributes of this section to take effect.
login	string	Login name, up to 128 characters.
`authenticate_type`	string	Authentication type: password - credentials are verified against the MiaRec database (default) ldap - credentials are verified on an LDAP server broadworks_webportal - BroadWorks web portal metaswitch_commportal - Metaswitch CommPortal saml - SAML 2.0 single sign-on
password	string	Password for the web portal. Write-only: it is never returned. Ignored when `authenticate_type` is not `password`. On update, the password is replaced.
`create_password_type`	string	Write-only, on creation. How the initial password is set: CREATE_USER_PASSWORD - use the `password` attribute (default) SEND_WELCOME_EMAIL_WITH_CREATE_PASS_LINK - send a welcome email with a link to create the password. Requires SMTP to be configured and password reset to be enabled in the password policy
`send_welcome_email`	boolean	Write-only, on creation. Send a welcome email to the new user. Requires `email`, SMTP, and password reset to be enabled. Not relevant when `create_password_type` is `SEND_WELCOME_EMAIL_WITH_CREATE_PASS_LINK`.
`must_change_password`	boolean	When `true`, the user must change the password at the next sign-in. Default `false`.
`require_2fa`	boolean	Require two-step verification for this user. Returned as `true` when two-step verification is enforced for everyone. Default `false`.
`valid_till`	datetime	Date, or date and time in ISO 8601 format, after which the user cannot sign in. `null` for no limit.

Fieldset "fieldset_recording"

Attribute	Type	Description
record	string	Recording rule: always - always record the calls of this user (default) ondemand - the user switches recording on and off during a call (on-demand recording) never - do not record default - use the system default rule
`on_demand_default`	string or null	For on-demand recording, what happens when the user takes no decision during a call: `keep` the recording or `discard` it. `null` when not applicable.
`record_direction`	list	Directions to record: `in` (inbound), `out` (outbound), or both. Default `["in", "out"]`.
extensions	list	Extensions (strings) associated with the user. Extensions match call recordings to users. A user may have several extensions, for example when the phone system sends the number in different formats such as `123456789` and `+123456789`.
`record_announcement`	integer or null	Recording announcement: `0` default, `1` always, `2` inbound, `3` outbound, `4` never. Relevant only with the Cisco TAPI integration.
confidential	boolean	Mark all calls of this user as confidential. Default `false`.

Fieldset "fieldset_screen_recording"

Attribute	Type	Description
`screen_recording_login`	string or null	Screen recording user name, in the format `NETBIOS\login`, `DOMAIN\login`, or `login`. Up to 128 characters.

Fieldset "fieldset_phone_services"

Attribute	Type	Description
`phone_pin`	string or null	PIN for phone softkey services, 3 to 32 digits. Write-only: the PIN is never returned, the attribute is `null` in responses.

Fieldset "fieldset_licensing"

Attribute	Type	Description
`recording_seat`	boolean	A call recording seat license is allocated to the user. Default `false`.
`screen_recording_seat`	boolean	A screen recording seat license is allocated to the user. Default `false`.
`monitoring_seat`	boolean	A live monitoring seat license is allocated to the user. Default `false`.
`evaluation_seat`	boolean	An agent evaluation seat license is allocated to the user. Default `false`.
`speech_analytics`	boolean	A speech analytics seat license is allocated to the user. Default `false`.
`speech_analytics_license_type`	string	Type of the speech analytics license: `basic` or `advanced` (default). Relevant only when basic licenses are enabled on the system.