GetPermissions - TCN API

GetPermissions returns the permissions for a given user along with other user information.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the GetPermissions RPC.

user

object (User)

user

optional

User entity.

created

string <date-time>

created

optional

The date/time the user was created.

Examples:

1s1.000340012s

last_updated

string <date-time>

last_updated

optional

The date/time the user was last updated.

Examples:

1s1.000340012s

connection_id

string

connection_id

optional

connection id is the id of the auth connection that the
user is coming from if it is a delgated user. If the user
is not delgated this will be nil.

time_zone_override

object (TimeZoneWrapper)

time_zone_override

optional

User TimeZone with wrapper for nullable timezone

default_application

enum<string>

default_application

optional

default_app for a user

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

user_id

string

user_id

optional

The ID of the user

org_id

string

org_id

optional

The ID of the org the user belongs to.

username

string

username

optional

The Username of the user.

p3_permission_group_id

string

p3_permission_group_id

optional

The ID of the p3 permission group the user has.

region_id

string

region_id

optional

The region the user belongs to.
This is going to be deprecated, RegionSidMap should be used.

partner_agent_id

string

partner_agent_id

optional

The User's partner agent id.

region_sid_map

object

region_sid_map

optional

The user's regional sids. The key of the map is a region id.

api_key

string

api_key

optional

payload

string

optional

The User's email.

login_disabled

boolean

login_disabled

optional

Whether or not the user is disabled.

auth_user_id

string

auth_user_id

optional

enable_mfa

boolean

enable_mfa

optional

first_name

string

first_name

optional

The user's first name.

last_name

string

last_name

optional

THe user's last name.

password_reset_required

boolean

password_reset_required

optional

Whether or not the user must reset their password on next login.

default_region

string

default_region

optional

List of regions for user
repeated string regions = 201;
region_id of a user entity

user_caller_id

string

user_caller_id

optional

P3 permission for user
User caller id

agent_profile_group_id

string

agent_profile_group_id

optional

users assigned agent profile group

skills

array[object (Skill) {4}]

skills

optional

The skills this user has as an agent, if any.

agent

boolean

agent

optional

a bool signalling whether or not the user is also an agent

account_owner

boolean

account_owner

optional

a bool to determine whether or not user is account owner

email_verified

boolean

email_verified

optional

Whether or not the user's email is verified.

login_sid

integer <int64> | string

login_sid

optional

The p3 login sid of the user.
This is going to be deprecated, RegionSidMap should be used.

agent_sid

integer <int64> | string

agent_sid

optional

The p3 agent sid of the user.
This is going to be deprecated, RegionSidMap should be used.

client_sid

integer <int64> | string

client_sid

optional

The p3 client sid of the user.

caller_ids

array[string]

caller_ids

optional

linkback_numbers

array[string]

linkback_numbers

optional

permission_group_ids

array[string]

permission_group_ids

optional

UserSettings

trust_ids

array[string]

trust_ids

optional

List of trust ids the user has been assigned.

whitelisted_ips

array[string]

whitelisted_ips

optional

Whitelisted IPs for the user

default_app

enum<string>

default_app

optional

Default operator application for user.

Allowed values:

permissions

array[string]

permissions

optional

List of permissions for the user.

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

p3_permissions

array[string]

p3_permissions

optional

List of legacy P3 permissions.

Allowed values:

NO_PERMISSIONVIEW_LIST_MANAGERCREATE_LIST_MANAGEREDIT_LIST_MANAGERDELETE_LIST_MANAGEREXECUTE_LIST_MANAGERVIEW_FIELD_DEFINITIONSCREATE_FIELD_DEFINITIONSEDIT_FIELD_DEFINITIONSDELETE_FIELD_DEFINITIONSEXECUTE_FIELD_DEFINITIONSVIEW_IMPORT_TEMPLATESCREATE_IMPORT_TEMPLATESEDIT_IMPORT_TEMPLATESDELETE_IMPORT_TEMPLATESEXECUTE_IMPORT_TEMPLATESVIEW_ADMIN_TOOLSCREATE_ADMIN_TOOLSEDIT_ADMIN_TOOLSDELETE_ADMIN_TOOLSEXECUTE_ADMIN_TOOLSVIEW_COUNTRY_MANAGERCREATE_COUNTRY_MANAGEREDIT_COUNTRY_MANAGERDELETE_COUNTRY_MANAGEREXECUTE_COUNTRY_MANAGERVIEW_DIAL_REGION_GROUPSCREATE_DIAL_REGION_GROUPSEDIT_DIAL_REGION_GROUPSDELETE_DIAL_REGION_GROUPSEXECUTE_DIAL_REGION_GROUPSVIEW_DIAL_REGIONCREATE_DIAL_REGIONEDIT_DIAL_REGIONDELETE_DIAL_REGIONEXECUTE_DIAL_REGIONVIEW_TTS_MANAGERCREATE_TTS_MANAGEREDIT_TTS_MANAGERDELETE_TTS_MANAGEREXECUTE_TTS_MANAGERVIEW_USER_MANAGEMENTCREATE_USER_MANAGEMENTEDIT_USER_MANAGEMENTDELETE_USER_MANAGEMENTEXECUTE_USER_MANAGEMENTVIEW_CLIENTCREATE_CLIENTEDIT_CLIENTDELETE_CLIENTEXECUTE_CLIENTVIEW_LOGINCREATE_LOGINEDIT_LOGINDELETE_LOGINEXECUTE_LOGINVIEW_PERMISSIONSCREATE_PERMISSIONSEDIT_PERMISSIONSDELETE_PERMISSIONSEXECUTE_PERMISSIONSVIEW_PERMISSIONS_GROUPSCREATE_PERMISSIONS_GROUPSEDIT_PERMISSIONS_GROUPSDELETE_PERMISSIONS_GROUPSEXECUTE_PERMISSIONS_GROUPSVIEW_PERMISSIONS_GROUP_ADMINISTRATORCREATE_PERMISSIONS_GROUP_ADMINISTRATOREDIT_PERMISSIONS_GROUP_ADMINISTRATORDELETE_PERMISSIONS_GROUP_ADMINISTRATOREXECUTE_PERMISSIONS_GROUP_ADMINISTRATORVIEW_CONTACT_USCREATE_CONTACT_USEDIT_CONTACT_USDELETE_CONTACT_USEXECUTE_CONTACT_USVIEW_USER_OPTIONSCREATE_USER_OPTIONSEDIT_USER_OPTIONSDELETE_USER_OPTIONSEXECUTE_USER_OPTIONSVIEW_CHANGE_PASSWORDCREATE_CHANGE_PASSWORDEDIT_CHANGE_PASSWORDDELETE_CHANGE_PASSWORDEXECUTE_CHANGE_PASSWORDVIEW_PREFERENCESCREATE_PREFERENCESEDIT_PREFERENCESDELETE_PREFERENCESEXECUTE_PREFERENCESVIEW_WEB_BROADCASTINGCREATE_WEB_BROADCASTINGEDIT_WEB_BROADCASTINGDELETE_WEB_BROADCASTINGEXECUTE_WEB_BROADCASTINGVIEW_REPORTSCREATE_REPORTSEDIT_REPORTSDELETE_REPORTSEXECUTE_REPORTSVIEW_SEND_BROADCASTCREATE_SEND_BROADCASTEDIT_SEND_BROADCASTDELETE_SEND_BROADCASTEXECUTE_SEND_BROADCASTVIEW_MESSAGE_MANAGERCREATE_MESSAGE_MANAGEREDIT_MESSAGE_MANAGERDELETE_MESSAGE_MANAGEREXECUTE_MESSAGE_MANAGERVIEW_TEMPLATE_MANAGERCREATE_TEMPLATE_MANAGEREDIT_TEMPLATE_MANAGERDELETE_TEMPLATE_MANAGEREXECUTE_TEMPLATE_MANAGERVIEW_DO_NOT_CALL_LISTCREATE_DO_NOT_CALL_LISTEDIT_DO_NOT_CALL_LISTDELETE_DO_NOT_CALL_LISTEXECUTE_DO_NOT_CALL_LISTVIEW_SCHEDULE_RULESCREATE_SCHEDULE_RULESEDIT_SCHEDULE_RULESDELETE_SCHEDULE_RULESEXECUTE_SCHEDULE_RULESVIEW_BILLINGCREATE_BILLINGEDIT_BILLINGDELETE_BILLINGEXECUTE_BILLINGVIEW_SAP_EXPORTCREATE_SAP_EXPORTEDIT_SAP_EXPORTDELETE_SAP_EXPORTEXECUTE_SAP_EXPORTVIEW_AUDITCREATE_AUDITEDIT_AUDITDELETE_AUDITEXECUTE_AUDITVIEW_AUTOMATED_REPORTINGCREATE_AUTOMATED_REPORTINGEDIT_AUTOMATED_REPORTINGDELETE_AUTOMATED_REPORTINGEXECUTE_AUTOMATED_REPORTINGVIEW_CUSTOMER_SERVICECREATE_CUSTOMER_SERVICEEDIT_CUSTOMER_SERVICEDELETE_CUSTOMER_SERVICEEXECUTE_CUSTOMER_SERVICEVIEW_SCRIPTSCREATE_SCRIPTSEDIT_SCRIPTSDELETE_SCRIPTSEXECUTE_SCRIPTSVIEW_CLIENT_PREFERENCESCREATE_CLIENT_PREFERENCESEDIT_CLIENT_PREFERENCESDELETE_CLIENT_PREFERENCESEXECUTE_CLIENT_PREFERENCESVIEW_RECORDINGS_REPORTINGCREATE_RECORDINGS_REPORTINGEDIT_RECORDINGS_REPORTINGDELETE_RECORDINGS_REPORTINGEXECUTE_RECORDINGS_REPORTINGVIEW_DEBUG_MODECREATE_DEBUG_MODEEDIT_DEBUG_MODEDELETE_DEBUG_MODEEXECUTE_DEBUG_MODECREATE_DNCL_MAPVIEW_DNCL_MAPEXECUTE_COPY_DOWNVIEW_AGENTSVIEW_ADMIN_CUSTOMER_SERVICEEDIT_AGENTSDELETE_AGENTSEXECUTE_AGENTSEDIT_HUNT_GROUPDELETE_HUNT_GROUPEXECUTE_HUNT_GROUPVIEW_HUNT_GROUPVIEW_AGENTS_REPORTVIEW_AGENTS_DASHBOARDVIEW_CALLER_ID_BUCKETSEDIT_CALLER_ID_BUCKETSCREATE_CALLER_ID_BUCKETSDELETE_CALLER_ID_BUCKETSEXECUTE_CALLER_ID_BUCKETSVIEW_REPORT_REQUESTCREATE_REPORT_REQUESTVIEW_INBOUND_SCRIPTSEDIT_INBOUND_SCRIPTSCREATE_INBOUND_SCRIPTSDELETE_INBOUND_SCRIPTSEDIT_BACKOFFICE_THEMECREATE_PHONE_NUMBER_MANAGEMENTEDIT_PHONE_NUMBER_MANAGEMENTVIEW_PHONE_NUMBER_MANAGEMENTDELETE_PHONE_NUMBER_MANAGEMENTEXECUTE_PHONE_NUMBER_MANAGEMENTEXECUTE_INBOUND_SCRIPTSEXECUTE_CELL_PHONE_SCRUBEDIT_ADMIN_CLIENT_PREFERENCESVIEW_ONTARIO_SYSTEMS_ADMINISTRATOREXECUTE_ONTARIO_SYSTEMS_ADMINISTRATOREXECUTE_ONTARIO_SYSTEMS_USERVIEW_INTEGRATION_MESSAGESVIEW_ONTARIO_SYSTEMS_USEREXECUTE_BROADCAST_CONTROL_INBOUNDEXECUTE_BROADCAST_CONTROL_MANUALEXECUTE_BROADCAST_CONTROL_OUTBOUNDCREATE_PREVIEW_ONLY_TEMPLATESCREATE_MAC_ONLY_TEMPLATESEDIT_TRIGGER_ADVANCE_ON_CALLCREATE_TRIGGER_ADVANCE_ON_CALLDELETE_MAC_ONLY_TEMPLATESEXECUTE_MAC_ONLY_TEMPLATESVIEW_MAC_ONLY_TEMPLATESEDIT_MAC_ONLY_TEMPLATESEXECUTE_PREVIEW_ONLY_TEMPLATESVIEW_PREVIEW_ONLY_TEMPLATESEDIT_PREVIEW_ONLY_TEMPLATESDELETE_PREVIEW_ONLY_TEMPLATESVIEW_ANALYTICS_REPORTINGCREATE_HUNT_GROUPCREATE_AGENTSCREATE_AGENTS_DASHBOARDCREATE_AGENTS_REPORTDELETE_AGENTS_DASHBOARDDELETE_AGENTS_REPORTEDIT_AGENTS_DASHBOARDEDIT_AGENTS_REPORTEXECUTE_AGENTS_DASHBOARDEXECUTE_AGENTS_REPORTDELETE_TRIGGER_ADVANCE_ON_CALLDELETE_CELL_PHONE_SCRUBCREATE_RINGLESS_VOICEMAIL_TEMPLATESEDIT_RINGLESS_VOICEMAIL_TEMPLATESCREATE_VOCALDIRECT_TEMPLATESEDIT_VOCALDIRECT_TEMPLATESVIEW_EMAILVIEW_SMSVIEW_EMAIL_REPORTSVIEW_EMAIL_AUDITVIEW_SMS_REPORTSVIEW_SMS_AUDITFAKE_PERMISSIONVIEW_CHATVIEW_CHAT_REPORTSVIEW_CHAT_AUDITVIEW_CAMPAIGNVIEW_CAMPAIGN_REPORTVIEW_CAMPAIGN_AUDITEDIT_SAP_ADMINEDIT_REPORT_REQUESTDELETE_REPORT_REQUESTEXECUTE_REPORT_REQUESTVIEW_BACKOFFICE_THEMECREATE_BACKOFFICE_THEMEDELETE_BACKOFFICE_THEMEEXECUTE_BACKOFFICE_THEMECREATE_CELL_PHONE_SCRUBEDIT_CELL_PHONE_SCRUBVIEW_CELL_PHONE_SCRUBVIEW_ADMIN_CLIENT_PREFERENCESDELETE_ADMIN_CLIENT_PREFERENCESCREATE_ADMIN_CLIENT_PREFERENCESEXECUTE_ADMIN_CLIENT_PREFERENCESCREATE_ONTARIO_SYSTEMS_ADMINISTRATORDELETE_ONTARIO_SYSTEMS_ADMINISTRATOREDIT_ONTARIO_SYSTEMS_ADMINISTRATORCREATE_ONTARIO_SYSTEMS_USERDELETE_ONTARIO_SYSTEMS_USEREDIT_ONTARIO_SYSTEMS_USERCREATE_INTEGRATION_MESSAGESDELETE_INTEGRATION_MESSAGESEDIT_INTEGRATION_MESSAGESEXECUTE_INTEGRATION_MESSAGESSCHEDULE_RESEND_CAMPAIGNAPP_AGENTAPP_BACKOFFICE

Example

{
  "user": {
    "created": "1s",
    "last_updated": "1s",
    "connection_id": "string",
    "time_zone_override": {
      "value": "TIME_ZONE_AMERICA_PUERTO_RICO"
    },
    "default_application": "AGENT_APP",
    "user_id": "string",
    "org_id": "string",
    "username": "string",
    "p3_permission_group_id": "string",
    "region_id": "string",
    "partner_agent_id": "string",
    "region_sid_map": {
      "property1": {
        "login_sid": 0,
        "agent_sid": 0,
        "client_sid": 0
      },
      "property2": {
        "login_sid": 0,
        "agent_sid": 0,
        "client_sid": 0
      }
    },
    "api_key": "string",
    "email": "string",
    "login_disabled": true,
    "auth_user_id": "string",
    "enable_mfa": true,
    "first_name": "string",
    "last_name": "string",
    "password_reset_required": true,
    "default_region": "string",
    "user_caller_id": "string",
    "agent_profile_group_id": "string",
    "skills": [
      {
        "name": "string",
        "description": "string",
        "level": 0,
        "skill_sid": 0
      }
    ],
    "agent": true,
    "account_owner": true,
    "email_verified": true,
    "login_sid": 0,
    "agent_sid": 0,
    "client_sid": 0,
    "caller_ids": [
      "string"
    ],
    "linkback_numbers": [
      "string"
    ],
    "permission_group_ids": [
      "string"
    ],
    "trust_ids": [
      "string"
    ],
    "whitelisted_ips": [
      "string"
    ]
  },
  "default_app": "AGENT_APP",
  "permissions": [
    "PERMISSION_UNSPECIFIED"
  ],
  "p3_permissions": [
    "NO_PERMISSION"
  ]
}

🔴500Server Error