TCN API

AdminGetUserDetails

POST

https://api.cbf.tcn.com/api/v0alpha/org/admin/user/details

Org

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

user_id

string

user_id

optional

Example

{
  "user_id": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/org/admin/user/details' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_id": "string"
}'

Responses

🟢200OK

application/json

Success

Body

default_app

enum<string>

default_app

optional

Default app the user starts on

Allowed values:

AGENT_APPORGANIZATION_MANAGEMENT_APPCUSTOMER_JOURNEY_SERVICES_APPLIST_MANAGEMENT_SERVICES_APPAGENT_MANAGER_APPNATURAL_LANGUAGE_COMPLIANCE_APPVOICE_ANALYTICS_APPSCRIPTS_APPROOM303_APPOMNI_BOSS_APPWFM_APPPAYMENTS_APPSUPPORT_APPBUSINESS_INTELLIGENCE_APPBACKOFFICE_APPSCORECARDS_APPDEV_TOOLS_APPLEARNING_CENTER_APPDELIVERY_SERVICE_APPPERFORMANCE_MANAGEMENT_APPTICKETS_APPAGENT_BETA_APPNEWSROOM_APPCONTACTMANAGER_APPKNOWLEDGE_BASE_APP

created

string <date-time>

created

optional

A Timestamp represents a point in time independent of any time zone or local
calendar, encoded as a count of seconds and fractions of seconds at
nanosecond resolution. The count is relative to an epoch at UTC midnight on
January 1, 1970, in the proleptic Gregorian calendar which extends the
Gregorian calendar backwards to year one.

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

In JSON format, the Timestamp type is encoded as a string in the
RFC 3339 format. That is, the
format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
where {year} is always expressed using four digits while {month}, {day},
{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
is required. A proto3 JSON serializer should always use UTC (as indicated by
"Z") when printing the Timestamp type and a proto3 JSON parser should be
able to accept both UTC and other timezones (as indicated by an offset).

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.

Examples:

1s1.000340012s

last_updated

string <date-time>

last_updated

optional

All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
second table is needed for interpretation, using a 24-hour linear
smear.

The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
restricting to that range, we ensure that we can convert to and from RFC
3339 date strings.

Examples

Example 1: Compute Timestamp from POSIX time().

Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);

Example 2: Compute Timestamp from POSIX gettimeofday().

struct timeval tv;
gettimeofday(&tv, NULL);

Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);

Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().

FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;

Example 4: Compute Timestamp from Java System.currentTimeMillis().

long millis = System.currentTimeMillis();

Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();

Example 5: Compute Timestamp from current time in Python.

timestamp = Timestamp()
timestamp.GetCurrentTime()

JSON Mapping

For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
01:30 UTC on January 15, 2017.

Examples:

1s1.000340012s

time_zone_override

object (TimeZoneWrapper)

time_zone_override

optional

User TimeZone with wrapper for nullable timezone

value

enum<string>

value

optional

Allowed values:

TIME_ZONE_AMERICA_PUERTO_RICOTIME_ZONE_AMERICA_NEW_YORKTIME_ZONE_AMERICA_INDIANAPOLISTIME_ZONE_AMERICA_CHICAGOTIME_ZONE_AMERICA_PHOENIXTIME_ZONE_AMERICA_DENVERTIME_ZONE_AMERICA_LOS_ANGELESTIME_ZONE_AMERICA_ANCHORAGETIME_ZONE_ASIA_MANILATIME_ZONE_ASIA_CALCUTTATIME_ZONE_ASIA_COLOMBOTIME_ZONE_PACIFIC_HONOLULUTIME_ZONE_CANADA_NEWFOUNDLANDTIME_ZONE_CANADA_ATLANTICTIME_ZONE_CANADA_CENTRALTIME_ZONE_CANADA_EAST_SASKATCHEWANTIME_ZONE_CANADA_EASTERNTIME_ZONE_CANADA_MOUNTAINTIME_ZONE_CANADA_PACIFICTIME_ZONE_CANADA_SASKATCHEWANTIME_ZONE_CANADA_YUKONTIME_ZONE_ETC_GREENWICHTIME_ZONE_ETC_UNIVERSALTIME_ZONE_EUROPE_LONDONTIME_ZONE_EUROPE_MADRIDTIME_ZONE_EUROPE_BERLINTIME_ZONE_EUROPE_BUCHARESTTIME_ZONE_AMERICA_MEXICO_CITYTIME_ZONE_MEXICO_BAJASURTIME_ZONE_MEXICO_BAJANORTETIME_ZONE_BRAZIL_ACRETIME_ZONE_BRAZIL_WESTTIME_ZONE_BRAZIL_EASTTIME_ZONE_BRAZIL_DENORONHATIME_ZONE_AUSTRALIA_DARWINTIME_ZONE_AUSTRALIA_ADELAIDETIME_ZONE_AUSTRALIA_SYDNEYTIME_ZONE_AUSTRALIA_BRISBANETIME_ZONE_AUSTRALIA_MELBOURNETIME_ZONE_AUSTRALIA_PERTHTIME_ZONE_PACIFIC_AUCKLANDTIME_ZONE_PACIFIC_CHATHAMTIME_ZONE_ASIA_SINGAPORETIME_ZONE_ASIA_JAPANTIME_ZONE_AMERICA_SANTIAGOTIME_ZONE_AMERICA_BOGOTATIME_ZONE_AMERICA_LIMA

locale_preferences_override

object (LocalePreferences)

locale_preferences_override

optional

The override for the users locale preferences

operator_display_language

object (OperatorDisplayLanguage)

operator_display_language

optional

The display language in Operator for users of the organization.

operator_language_direction

enum<string>

operator_language_direction

optional

The direction of the language used in the organization.

Allowed values:

OPERATOR_LANGUAGE_DIRECTION_UNSPECIFIEDOPERATOR_LANGUAGE_DIRECTION_DEFAULTOPERATOR_LANGUAGE_DIRECTION_LEFT_TO_RIGHTOPERATOR_LANGUAGE_DIRECTION_RIGHT_TO_LEFT

language_tag

string

language_tag

deprecated

Display language in Operator for users of the organization.
Must be a valid language tag supported in Operator.
IETF BCP 47 - https://en.wikipedia.org/wiki/IETF_language_tag
DEPRECATED: use operator_display_language instead.

use_script_direction_right_to_left

boolean

use_script_direction_right_to_left

deprecated

The direction of the script in Operator used in the organization.
By default, it is set to false to indicate left-to-right.
DEPRECATED: use language_direction_preference instead.

default_currency

string

default_currency

optional

The default currency used in the organization.
Must be a valid currency code supported in Operator.
ISO 4217 - https://en.wikipedia.org/wiki/ISO_4217.

password_reset_date

string <date-time>

password_reset_date

optional

Password reset date is the timestamp of when a user must reset their password by.

Examples:

1s1.000340012s

user_id

string

user_id

optional

user_name

string

user_name

optional

organization_name

string

organization_name

optional

location_name

string

location_name

optional

p3_permission_group

string

p3_permission_group

optional

Legacy P3 permission group

permission_groups

array[object (PermissionGroup) {5}]

permission_groups

optional

List of permission groups for this user.

string

optional

Unique id for this permission group.

name

string

name

optional

Name to identify by.

description

string

description

optional

Brief description of this group of permissions.

permissions

array[string]

permissions

optional

List of permissions in this group.

Allowed values:

PERMISSION_UNSPECIFIEDPERMISSION_DEVPERMISSION_LEARN_EDITPERMISSION_ORG_EDITPERMISSION_ORG_VIEWPERMISSION_OWNING_ORG_IMITATIONPERMISSION_USER_CREATEPERMISSION_USER_EDITPERMISSION_USER_EDIT_PASSWORDPERMISSION_USER_EDIT_OPTIONSPERMISSION_LOGIN_CONNECTIONSPERMISSION_USER_EDIT_AGENT_CALLER_IDPERMISSION_ACCESS_TOKEN_MANAGMENTPERMISSION_AGENT_MANAGEMENTPERMISSION_PERMISSION_GROUP_EDITPERMISSION_PERMISSION_GROUP_ASSIGNPERMISSION_LABEL_MANAGEMENTPERMISSION_LABEL_ATTACHPERMISSION_TRUST_MANAGEMENTPERMISSION_HUNTGROUP_VIEWPERMISSION_HUNTGROUP_EDITPERMISSION_AGENT_SCRIPTS_VIEWPERMISSION_AGENT_SCRIPTS_EDITPERMISSION_SOUNDBOARD_VIEWPERMISSION_SOUNDBOARD_EDITPERMISSION_SUBSCRIPTION_MANAGEMENTPERMISSION_COPY_TO_ORGANIZATIONPERMISSION_CUSTOMER_SUPPORTPERMISSION_IMITATIONPERMISSION_BILLING_EDITPERMISSION_TCN_ADMIN_SETTINGSPERMISSION_TCN_BILLINGPERMISSION_TCN_BILLING_ADMINPERMISSION_SUPPORT_TCN_INSIGHTS_ADMINPERMISSION_SUPPORT_TCN_DASHBOARDS_ADMINPERMISSION_AGENTPERMISSION_ACCEPT_QUEUED_CALLSPERMISSION_VIEW_HOLD_QUEUEPERMISSION_VIEW_CAMPAIGN_COMPLETIONPERMISSION_VIEW_VOICE_MAILPERMISSION_AGENT_COMPLIANCE_SCRUBLIST_OPTIONSPERMISSION_EXTENSION_EDITPERMISSION_VOICEMAIL_DOWNLOADPERMISSION_AGENT_PORTALS_VIEWPERMISSION_MANUAL_APPROVEPERMISSION_AGENT_PLUGINS_VIEWPERMISSION_AGENT_HUNTGROUP_INTEGRATIONS_VIEWPERMISSION_MANUAL_CONVERSATIONPERMISSION_AGENT_ASSISTED_PORTALPERMISSION_CHANGE_OWN_HUNT_GROUPPERMISSION_CHANGE_OWN_SKILL_GROUPSPERMISSION_VOICE_ANALYTICSPERMISSION_VOICE_ANALYTICS_FLAGPERMISSION_VOICE_ANALYTICS_CONFIGPERMISSION_VOICE_ANALYTICS_RECORDING_DOWNLOADPERMISSION_VOICE_ANALYTICS_TRANSCRIPT_DOWNLOADPERMISSION_VOICE_ANALYTICS_SCREEN_RECORDINGPERMISSION_VOICE_ANALYTICS_TRANSCRIPT_DELETEPERMISSION_VOICE_ANALYTICS_SCREEN_RECORDING_DELETEPERMISSION_BUSINESS_INTELLIGENCEPERMISSION_DASHBOARDS_VIEWPERMISSION_DASHBOARDS_EDITPERMISSION_INSIGHTS_COMMON_LIBRARY_MANAGEPERMISSION_INSIGHTS_MANAGEPERMISSION_INSIGHTS_INSIGHT_VIEWPERMISSION_INSIGHTS_INSIGHT_EDITPERMISSION_INSIGHTS_DASHBOARD_VIEWPERMISSION_INSIGHTS_DASHBOARD_EDITPERMISSION_REPORT_GENERATOR_EDITPERMISSION_ROOM303PERMISSION_ROOM303_MEMBERPERMISSION_ROOM303_SUPERVISORPERMISSION_AGENT_CALL_SCRIPTSPERMISSION_COMPLIANCEPERMISSION_COMPLIANCE_CONSENTPERMISSION_LMS_VIEWPERMISSION_LMS_EDITPERMISSION_OMNI_BOSSPERMISSION_OMNI_BOSS_EDITPERMISSION_OMNI_PORTALS_VIEWPERMISSION_INTEGRATIONS_VIEWPERMISSION_INTEGRATIONS_PAYMENTPERMISSION_INTEGRATIONS_JOURNEYPERMISSIONS_INTEGRATIONS_KEY_CREATIONPERMISSION_WFMPERMISSION_AGENT_PORTALPERMISSION_WFM_ADHERENCE_ADMINPERMISSION_WFM_ADHERENCE_MANAGERPERMISSION_WFM_ADHERENCE_MONITORPERMISSION_SCORECARDSPERMISSION_SCORECARDS_MANAGEPERMISSION_SCORECARDS_EVALUATEPERMISSION_SCORECARDS_FLAG_EVALPERMISSION_SCORECARDS_LEARNING_OPPORTUNITIESPERMISSION_DEV_TOOLSPERMISSION_DELIVERY_NOTIFICATIONS_VIEWPERMISSION_DELIVERY_NOTIFICATIONS_EDITPERMISSION_TICKETS_APPPERMISSION_TICKETS_ADMINPERMISSION_WORKFLOWSPERMISSION_PBX_MANAGER_VIEWPERMISSION_PBX_MANAGER_EDITPERMISSION_PBX_SOFTPHONE_WIDGETPERMISSION_NEWSROOM_VIEWPERMISSION_NEWSROOM_EDITPERMISSION_NEWSROOM_PUBLISHPERMISSION_NEWSROOM_CLIENT_CONTROLPERMISSION_CONTACTMANAGER_ADMINPERMISSION_CONTACTMANAGER_APPPERMISSION_KNOWLEDGE_BASE_EDITPERMISSION_RULE_ENGINE

read_only

boolean

read_only

optional

Restricts users from modifying this group.

default_region

string

default_region

optional

disabled

boolean

disabled

optional

partner_agent_id

string

partner_agent_id

optional

org_id

string

org_id

optional

user_caller_id

string

user_caller_id

optional

hunt_group_name

string

hunt_group_name

optional

skills

array[object (Skill) {4}]

skills

optional

name

string

name

optional

description

string

description

optional

level

integer <int64> | string

level

optional

skill_sid

integer <int64> | string

skill_sid

optional

first_name

string

first_name

optional

last_name

string

last_name

optional

password_reset_required

boolean

password_reset_required

optional

agent_profile_group_id

string

agent_profile_group_id

optional

label_entities

array[object (Label) {5}]

label_entities

optional

A list of labels assigned to the user

name

string

name

optional

simply the name of the label.
'Team A', 'Medical', etc

description

string

description

optional

the description of the label.

color

string

color

optional

Hex color code of the label.

label_id

string

label_id

optional

Id of the label.

deleted

boolean

deleted

optional

whether or not the label is deleted.

delegated

boolean

delegated

optional

Boolean for whether or not the user is a delegated login authenticated through a third party provider.
Delegated login users are from connected login managements like Azure or Okta

string

optional

email of the user. empty if none set

email_verified

boolean

email_verified

optional

if the user's email is verified

trusts

array[object (Trust) {9}]

trusts

optional

Trusts assigned to the user.

status

enum<string>

status

optional

Status of the Trust.

Allowed values:

PENDINGREJECTEDACCEPTED

trust_id

string

trust_id

optional

ID of the trust.

grantor

string

grantor

optional

Org ID of the org giving out the trust.

grantee

string

grantee

optional

Org ID of the org receiving the trust.

name

string

name

optional

Name of the trust.

description

string

description

optional

Description of the trust.

permissions

array[string]

permissions

optional

Permissions the grantor allows users within the
grantee org to have when assigned.

Allowed values:

labels

array[object (Label) {6}]

labels

optional

Labels associated with the trusted permissions.

deleted

boolean

deleted

optional

allowed_regions

array[string]

allowed_regions

optional

agent_sid

integer <int64> | string

agent_sid

optional

linkback_numbers

array[string]

linkback_numbers

optional

caller_ids

array[string]

caller_ids

optional

login_sid

integer <int64> | string

login_sid

optional

hunt_group_sid

integer <int64> | string

hunt_group_sid

optional

Example

{
  "default_app": "AGENT_APP",
  "created": "1s",
  "last_updated": "1s",
  "time_zone_override": {
    "value": "TIME_ZONE_AMERICA_PUERTO_RICO"
  },
  "locale_preferences_override": {
    "operator_display_language": {
      "value": "string"
    },
    "operator_language_direction": "OPERATOR_LANGUAGE_DIRECTION_UNSPECIFIED",
    "language_tag": "string",
    "use_script_direction_right_to_left": true,
    "default_currency": "string"
  },
  "password_reset_date": "1s",
  "user_id": "string",
  "user_name": "string",
  "organization_name": "string",
  "location_name": "string",
  "p3_permission_group": "string",
  "permission_groups": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "permissions": [
        "PERMISSION_UNSPECIFIED"
      ],
      "read_only": true
    }
  ],
  "default_region": "string",
  "disabled": true,
  "partner_agent_id": "string",
  "org_id": "string",
  "user_caller_id": "string",
  "hunt_group_name": "string",
  "skills": [
    {
      "name": "string",
      "description": "string",
      "level": 0,
      "skill_sid": 0
    }
  ],
  "first_name": "string",
  "last_name": "string",
  "password_reset_required": true,
  "agent_profile_group_id": "string",
  "label_entities": [
    {
      "name": "string",
      "description": "string",
      "color": "string",
      "label_id": "string",
      "deleted": true
    }
  ],
  "delegated": true,
  "email": "string",
  "email_verified": true,
  "trusts": [
    {
      "status": "PENDING",
      "trust_id": "string",
      "grantor": "string",
      "grantee": "string",
      "name": "string",
      "description": "string",
      "permissions": [
        "PERMISSION_UNSPECIFIED"
      ],
      "labels": [
        {
          "org_id": "string",
          "name": "string",
          "description": "string",
          "color": "string",
          "label_id": "string",
          "deleted": true
        }
      ],
      "deleted": true
    }
  ],
  "allowed_regions": [
    "string"
  ],
  "agent_sid": 0,
  "linkback_numbers": [
    "string"
  ],
  "caller_ids": [
    "string"
  ],
  "login_sid": 0,
  "hunt_group_sid": 0
}

🔴500Server Error

GetUserDetails

GetAgentUsers