auth

package
v1.7.29 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 4, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Permission_name = map[int32]string{
		0:    "PERMISSION_UNSPECIFIED",
		1:    "PERMISSION_DEV",
		10:   "PERMISSION_LEARN_EDIT",
		100:  "PERMISSION_ORG_EDIT",
		101:  "PERMISSION_ORG_VIEW",
		130:  "PERMISSION_OWNING_ORG_IMITATION",
		118:  "PERMISSION_USER_CREATE",
		119:  "PERMISSION_USER_EDIT",
		120:  "PERMISSION_USER_EDIT_PASSWORD",
		121:  "PERMISSION_USER_EDIT_OPTIONS",
		260:  "PERMISSION_LOGIN_CONNECTIONS",
		122:  "PERMISSION_USER_EDIT_AGENT_CALLER_ID",
		400:  "PERMISSION_AGENT_MANAGEMENT",
		110:  "PERMISSION_PERMISSION_GROUP_EDIT",
		111:  "PERMISSION_PERMISSION_GROUP_ASSIGN",
		150:  "PERMISSION_LABEL_MANAGEMENT",
		160:  "PERMISSION_TRUST_MANAGEMENT",
		1900: "PERMISSION_HUNTGROUP_VIEW",
		1901: "PERMISSION_HUNTGROUP_EDIT",
		1700: "PERMISSION_SOUNDBOARD_VIEW",
		1701: "PERMISSION_SOUNDBOARD_EDIT",
		140:  "PERMISSION_SUBSCRIPTION_MANAGEMENT",
		200:  "PERMISSION_CUSTOMER_SUPPORT",
		210:  "PERMISSION_IMITATION",
		220:  "PERMISSION_BILLING_EDIT",
		230:  "PERMISSION_TCN_ADMIN_SETTINGS",
		240:  "PERMISSION_TCN_BILLING",
		300:  "PERMISSION_AGENT",
		310:  "PERMISSION_ACCEPT_QUEUED_CALLS",
		320:  "PERMISSION_VIEW_CAMPAIGN_COMPLETION",
		321:  "PERMISSION_VIEW_VOICE_MAIL",
		330:  "PERMISSION_AGENT_COMPLIANCE_SCRUBLIST_OPTIONS",
		1400: "PERMISSION_EXTENSION_EDIT",
		1401: "PERMISSION_VOICEMAIL_DOWNLOAD",
		340:  "PERMISSION_AGENT_PORTALS_VIEW",
		500:  "PERMISSION_VOICE_ANALYTICS",
		501:  "PERMISSION_VOICE_ANALYTICS_FLAG",
		502:  "PERMISSION_VOICE_ANALYTICS_CONFIG",
		503:  "PERMISSION_VOICE_ANALYTICS_RECORDING_DOWNLOAD",
		504:  "PERMISSION_VOICE_ANALYTICS_TRANSCRIPT_DOWNLOAD",
		505:  "PERMISSION_VOICE_ANALYTICS_SCREEN_RECORDING",
		506:  "PERMISSION_VOICE_ANALYTICS_TRANSCRIPT_DELETE",
		507:  "PERMISSION_VOICE_ANALYTICS_SCREEN_RECORDING_DELETE",
		600:  "PERMISSION_BUSINESS_INTELLIGENCE",
		601:  "PERMISSION_DASHBOARDS_VIEW",
		602:  "PERMISSION_DASHBOARDS_EDIT",
		603:  "PERMISSION_INSIGHTS_COMMON_LIBRARY_MANAGE",
		604:  "PERMISSION_INSIGHTS_MANAGE",
		700:  "PERMISSION_ROOM303",
		800:  "PERMISSION_AGENT_CALL_SCRIPTS",
		900:  "PERMISSION_COMPLIANCE",
		910:  "PERMISSION_COMPLIANCE_CONSENT",
		1000: "PERMISSION_LMS_VIEW",
		1001: "PERMISSION_LMS_EDIT",
		1200: "PERMISSION_OMNI_BOSS",
		1210: "PERMISSION_OMNI_PORTALS_VIEW",
		1300: "PERMISSION_INTEGRATIONS_VIEW",
		1301: "PERMISSION_INTEGRATIONS_PAYMENT",
		1302: "PERMISSION_INTEGRATIONS_JOURNEY",
		1500: "PERMISSION_WFM",
		1600: "PERMISSION_SCORECARDS",
		1601: "PERMISSION_SCORECARDS_MANAGE",
		1602: "PERMISSION_SCORECARDS_EVALUATE",
		1800: "PERMISSION_DEV_TOOLS",
		2000: "PERMISSION_DELIVERY_NOTIFICATIONS_VIEW",
		2001: "PERMISSION_DELIVERY_NOTIFICATIONS_EDIT",
		3100: "PERMISSION_TICKETS_APP",
		3101: "PERMISSION_TICKETS_ADMIN",
		4000: "PERMISSION_WORKFLOWS",
		4100: "PERMISSION_PBX_MANAGER_VIEW",
		4101: "PERMISSION_PBX_MANAGER_EDIT",
	}
	Permission_value = map[string]int32{
		"PERMISSION_UNSPECIFIED":                             0,
		"PERMISSION_DEV":                                     1,
		"PERMISSION_LEARN_EDIT":                              10,
		"PERMISSION_ORG_EDIT":                                100,
		"PERMISSION_ORG_VIEW":                                101,
		"PERMISSION_OWNING_ORG_IMITATION":                    130,
		"PERMISSION_USER_CREATE":                             118,
		"PERMISSION_USER_EDIT":                               119,
		"PERMISSION_USER_EDIT_PASSWORD":                      120,
		"PERMISSION_USER_EDIT_OPTIONS":                       121,
		"PERMISSION_LOGIN_CONNECTIONS":                       260,
		"PERMISSION_USER_EDIT_AGENT_CALLER_ID":               122,
		"PERMISSION_AGENT_MANAGEMENT":                        400,
		"PERMISSION_PERMISSION_GROUP_EDIT":                   110,
		"PERMISSION_PERMISSION_GROUP_ASSIGN":                 111,
		"PERMISSION_LABEL_MANAGEMENT":                        150,
		"PERMISSION_TRUST_MANAGEMENT":                        160,
		"PERMISSION_HUNTGROUP_VIEW":                          1900,
		"PERMISSION_HUNTGROUP_EDIT":                          1901,
		"PERMISSION_SOUNDBOARD_VIEW":                         1700,
		"PERMISSION_SOUNDBOARD_EDIT":                         1701,
		"PERMISSION_SUBSCRIPTION_MANAGEMENT":                 140,
		"PERMISSION_CUSTOMER_SUPPORT":                        200,
		"PERMISSION_IMITATION":                               210,
		"PERMISSION_BILLING_EDIT":                            220,
		"PERMISSION_TCN_ADMIN_SETTINGS":                      230,
		"PERMISSION_TCN_BILLING":                             240,
		"PERMISSION_AGENT":                                   300,
		"PERMISSION_ACCEPT_QUEUED_CALLS":                     310,
		"PERMISSION_VIEW_CAMPAIGN_COMPLETION":                320,
		"PERMISSION_VIEW_VOICE_MAIL":                         321,
		"PERMISSION_AGENT_COMPLIANCE_SCRUBLIST_OPTIONS":      330,
		"PERMISSION_EXTENSION_EDIT":                          1400,
		"PERMISSION_VOICEMAIL_DOWNLOAD":                      1401,
		"PERMISSION_AGENT_PORTALS_VIEW":                      340,
		"PERMISSION_VOICE_ANALYTICS":                         500,
		"PERMISSION_VOICE_ANALYTICS_FLAG":                    501,
		"PERMISSION_VOICE_ANALYTICS_CONFIG":                  502,
		"PERMISSION_VOICE_ANALYTICS_RECORDING_DOWNLOAD":      503,
		"PERMISSION_VOICE_ANALYTICS_TRANSCRIPT_DOWNLOAD":     504,
		"PERMISSION_VOICE_ANALYTICS_SCREEN_RECORDING":        505,
		"PERMISSION_VOICE_ANALYTICS_TRANSCRIPT_DELETE":       506,
		"PERMISSION_VOICE_ANALYTICS_SCREEN_RECORDING_DELETE": 507,
		"PERMISSION_BUSINESS_INTELLIGENCE":                   600,
		"PERMISSION_DASHBOARDS_VIEW":                         601,
		"PERMISSION_DASHBOARDS_EDIT":                         602,
		"PERMISSION_INSIGHTS_COMMON_LIBRARY_MANAGE":          603,
		"PERMISSION_INSIGHTS_MANAGE":                         604,
		"PERMISSION_ROOM303":                                 700,
		"PERMISSION_AGENT_CALL_SCRIPTS":                      800,
		"PERMISSION_COMPLIANCE":                              900,
		"PERMISSION_COMPLIANCE_CONSENT":                      910,
		"PERMISSION_LMS_VIEW":                                1000,
		"PERMISSION_LMS_EDIT":                                1001,
		"PERMISSION_OMNI_BOSS":                               1200,
		"PERMISSION_OMNI_PORTALS_VIEW":                       1210,
		"PERMISSION_INTEGRATIONS_VIEW":                       1300,
		"PERMISSION_INTEGRATIONS_PAYMENT":                    1301,
		"PERMISSION_INTEGRATIONS_JOURNEY":                    1302,
		"PERMISSION_WFM":                                     1500,
		"PERMISSION_SCORECARDS":                              1600,
		"PERMISSION_SCORECARDS_MANAGE":                       1601,
		"PERMISSION_SCORECARDS_EVALUATE":                     1602,
		"PERMISSION_DEV_TOOLS":                               1800,
		"PERMISSION_DELIVERY_NOTIFICATIONS_VIEW":             2000,
		"PERMISSION_DELIVERY_NOTIFICATIONS_EDIT":             2001,
		"PERMISSION_TICKETS_APP":                             3100,
		"PERMISSION_TICKETS_ADMIN":                           3101,
		"PERMISSION_WORKFLOWS":                               4000,
		"PERMISSION_PBX_MANAGER_VIEW":                        4100,
		"PERMISSION_PBX_MANAGER_EDIT":                        4101,
	}
)

Enum value maps for Permission.

View Source 
var File_api_commons_auth_perms_proto protoreflect.FileDescriptor
View Source 
var File_api_commons_auth_user_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AuthClaims 

type AuthClaims struct {

	// AUTH0 user_id
	Auth0UserId string `protobuf:"bytes,1,opt,name=auth0_user_id,json=auth0UserId,proto3" json:"auth0_user_id,omitempty"`
	// ORG user_id
	OrgUserId string `protobuf:"bytes,2,opt,name=org_user_id,json=orgUserId,proto3" json:"org_user_id,omitempty"`
	// ORG ID
	OrgId string `protobuf:"bytes,3,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	// API key used in this request for API-based endpoints
	ApiKey string `protobuf:"bytes,4,opt,name=api_key,json=apiKey,proto3" json:"api_key,omitempty"`
	// ORG Region ID
	RegionId string `protobuf:"bytes,5,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// ??
	Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
	// Impersonation information
	Impersonate string `protobuf:"bytes,7,opt,name=impersonate,proto3" json:"impersonate,omitempty"`
	// P3 Client SID from "client" table
	ClientSid int64 `protobuf:"varint,1000,opt,name=client_sid,json=clientSid,proto3" json:"client_sid,omitempty"`
	// P3 Agent SID from "agent" table
	AgentSid int64 `protobuf:"varint,1001,opt,name=agent_sid,json=agentSid,proto3" json:"agent_sid,omitempty"`
	// Mapped to agent_sid
	LoginSid int64 `protobuf:"varint,1002,opt,name=login_sid,json=loginSid,proto3" json:"login_sid,omitempty"`
	// ActiveOrgId is the org being used in behalf of for the api call
	ActiveOrgId string `protobuf:"bytes,1100,opt,name=active_org_id,json=activeOrgId,proto3" json:"active_org_id,omitempty"`
	// contains filtered or unexported fields
}

AuthClaims is a proto mapping of the JWT Claims

func (*AuthClaims) Descriptor deprecated 

func (*AuthClaims) Descriptor() ([]byte, []int)

Deprecated: Use AuthClaims.ProtoReflect.Descriptor instead.

func (*AuthClaims) GetActiveOrgId 

func (x *AuthClaims) GetActiveOrgId() string

func (*AuthClaims) GetAgentSid 

func (x *AuthClaims) GetAgentSid() int64

func (*AuthClaims) GetApiKey 

func (x *AuthClaims) GetApiKey() string

func (*AuthClaims) GetAuth0UserId 

func (x *AuthClaims) GetAuth0UserId() string

func (*AuthClaims) GetClientSid 

func (x *AuthClaims) GetClientSid() int64

func (*AuthClaims) GetImpersonate 

func (x *AuthClaims) GetImpersonate() string

func (*AuthClaims) GetLoginSid 

func (x *AuthClaims) GetLoginSid() int64

func (*AuthClaims) GetName 

func (x *AuthClaims) GetName() string

func (*AuthClaims) GetOrgId 

func (x *AuthClaims) GetOrgId() string

func (*AuthClaims) GetOrgUserId 

func (x *AuthClaims) GetOrgUserId() string

func (*AuthClaims) GetRegionId 

func (x *AuthClaims) GetRegionId() string

func (*AuthClaims) ProtoMessage 

func (*AuthClaims) ProtoMessage()

func (*AuthClaims) ProtoReflect 

func (x *AuthClaims) ProtoReflect() protoreflect.Message

func (*AuthClaims) Reset 

func (x *AuthClaims) Reset()

func (*AuthClaims) String 

func (x *AuthClaims) String() string

type AuthenticatedUser 

type AuthenticatedUser struct {

	// JWT Claims
	Claims *AuthClaims `protobuf:"bytes,1,opt,name=claims,proto3" json:"claims,omitempty"`
	// contains filtered or unexported fields
}

AuthenticatedUser is a proto serialized version of AuthUser. It can be used to pass all AuthUser information towards the backends

func (*AuthenticatedUser) Descriptor deprecated 

func (*AuthenticatedUser) Descriptor() ([]byte, []int)

Deprecated: Use AuthenticatedUser.ProtoReflect.Descriptor instead.

func (*AuthenticatedUser) GetClaims 

func (x *AuthenticatedUser) GetClaims() *AuthClaims

func (*AuthenticatedUser) ProtoMessage 

func (*AuthenticatedUser) ProtoMessage()

func (*AuthenticatedUser) ProtoReflect 

func (x *AuthenticatedUser) ProtoReflect() protoreflect.Message

func (*AuthenticatedUser) Reset 

func (x *AuthenticatedUser) Reset()

func (*AuthenticatedUser) String 

func (x *AuthenticatedUser) String() string

type Permission 

type Permission int32

Permission enum contains the permissions to be used for access control. 

const (
	// 0 explicitly means unspecified or invalid.
	Permission_PERMISSION_UNSPECIFIED Permission = 0
	// Enables viewing WIP or unreleased features in development.
	Permission_PERMISSION_DEV Permission = 1
	// Enables editing learning center materials.
	Permission_PERMISSION_LEARN_EDIT Permission = 10
	// Enables editing organization data using the organization tools.
	Permission_PERMISSION_ORG_EDIT Permission = 100
	// Enables viewing organization related views and data using the
	// organization tools.
	Permission_PERMISSION_ORG_VIEW Permission = 101
	// Enables user account imitation for users within the p3 client hierarchy.
	Permission_PERMISSION_OWNING_ORG_IMITATION Permission = 130
	// Enables ability to create users.
	Permission_PERMISSION_USER_CREATE Permission = 118
	// Enables ability to edit users.
	Permission_PERMISSION_USER_EDIT Permission = 119
	// Enable ability for user to change their own password.
	Permission_PERMISSION_USER_EDIT_PASSWORD Permission = 120
	// Enable ability for user to change their user options.
	Permission_PERMISSION_USER_EDIT_OPTIONS Permission = 121
	// Allows viewing and editing delegated login connections.
	Permission_PERMISSION_LOGIN_CONNECTIONS Permission = 260
	// Allows viewing and editing of Agent Caller ID.
	Permission_PERMISSION_USER_EDIT_AGENT_CALLER_ID Permission = 122
	// Enables access to agent management app for assigning skills,
	// huntgroup, etc.
	Permission_PERMISSION_AGENT_MANAGEMENT Permission = 400
	// Enables creating and editing of permission groups.
	Permission_PERMISSION_PERMISSION_GROUP_EDIT Permission = 110
	// Enables ability to assign permission groups to users.
	Permission_PERMISSION_PERMISSION_GROUP_ASSIGN Permission = 111
	// Enables CRUD operations for Labels.
	Permission_PERMISSION_LABEL_MANAGEMENT Permission = 150
	// Enables CRUD operations for Trusts.
	Permission_PERMISSION_TRUST_MANAGEMENT Permission = 160
	// Enables access to get hunt group properties and settings.
	Permission_PERMISSION_HUNTGROUP_VIEW Permission = 1900
	// Enables access to update hunt group properties and settings.
	Permission_PERMISSION_HUNTGROUP_EDIT Permission = 1901
	// Enables access to get and list soundboard files.
	Permission_PERMISSION_SOUNDBOARD_VIEW Permission = 1700
	// Enables access to create, update, or delete soundboard files.
	Permission_PERMISSION_SOUNDBOARD_EDIT Permission = 1701
	// Enables user to view and mangage all org subscriptions.
	Permission_PERMISSION_SUBSCRIPTION_MANAGEMENT Permission = 140
	// Enables the customer support tools.
	Permission_PERMISSION_CUSTOMER_SUPPORT Permission = 200
	// Enables user account imitation.
	Permission_PERMISSION_IMITATION Permission = 210
	// Enables editing data using billing related tools.
	Permission_PERMISSION_BILLING_EDIT Permission = 220
	// gives access to and editing of admin settings.
	Permission_PERMISSION_TCN_ADMIN_SETTINGS Permission = 230
	// Enables sensitive and specific billing tools for TCN employees only.
	Permission_PERMISSION_TCN_BILLING Permission = 240
	// Enables access to agent.
	Permission_PERMISSION_AGENT               Permission = 300
	Permission_PERMISSION_ACCEPT_QUEUED_CALLS Permission = 310
	// Enables ability to view the campaign completion box.
	Permission_PERMISSION_VIEW_CAMPAIGN_COMPLETION Permission = 320
	// Ability to view voice mails for agents.
	Permission_PERMISSION_VIEW_VOICE_MAIL Permission = 321
	// Enabled access to scrublist options on calls.
	Permission_PERMISSION_AGENT_COMPLIANCE_SCRUBLIST_OPTIONS Permission = 330
	// Enables access to edit extensions.
	Permission_PERMISSION_EXTENSION_EDIT Permission = 1400
	// Enables downloading of voicemails.
	Permission_PERMISSION_VOICEMAIL_DOWNLOAD Permission = 1401
	// Enables Agents to view portals.
	Permission_PERMISSION_AGENT_PORTALS_VIEW Permission = 340
	// Enables access to voice analytics app.
	Permission_PERMISSION_VOICE_ANALYTICS Permission = 500
	// Enables access to managing flags within voice analytics.
	Permission_PERMISSION_VOICE_ANALYTICS_FLAG Permission = 501
	// Enables access to configuration within voice analytics.
	Permission_PERMISSION_VOICE_ANALYTICS_CONFIG Permission = 502
	// Enables ability to download recordings within voice analytics.
	Permission_PERMISSION_VOICE_ANALYTICS_RECORDING_DOWNLOAD Permission = 503
	// Enables ability to download transcripts within voice analytics.
	Permission_PERMISSION_VOICE_ANALYTICS_TRANSCRIPT_DOWNLOAD Permission = 504
	// Enables access to voice analytics screenRecording navigation.
	Permission_PERMISSION_VOICE_ANALYTICS_SCREEN_RECORDING Permission = 505
	// Enables ability to delete transcripts within voice analytics.
	Permission_PERMISSION_VOICE_ANALYTICS_TRANSCRIPT_DELETE Permission = 506
	// Enables ability to delete screen recordings.
	Permission_PERMISSION_VOICE_ANALYTICS_SCREEN_RECORDING_DELETE Permission = 507
	// Enables access to BI analytics app.
	Permission_PERMISSION_BUSINESS_INTELLIGENCE Permission = 600
	// Enables ability to view BI dashboards.
	Permission_PERMISSION_DASHBOARDS_VIEW Permission = 601
	// Enables ability to edit BI dashboards.
	Permission_PERMISSION_DASHBOARDS_EDIT Permission = 602
	// Enables writes for common library insights.
	Permission_PERMISSION_INSIGHTS_COMMON_LIBRARY_MANAGE Permission = 603
	// Enables access to insights.
	Permission_PERMISSION_INSIGHTS_MANAGE Permission = 604
	// Enables access to room 303 chat.
	Permission_PERMISSION_ROOM303 Permission = 700
	// Enables access to the call scripts builder app.
	Permission_PERMISSION_AGENT_CALL_SCRIPTS Permission = 800
	// Enables access to the compliance app.
	Permission_PERMISSION_COMPLIANCE Permission = 900
	// Enables access to compliance consent profiles .
	Permission_PERMISSION_COMPLIANCE_CONSENT Permission = 910
	// Enables access to viewing the List Management Services app.
	Permission_PERMISSION_LMS_VIEW Permission = 1000
	// Enables access to editing LMS properties.
	Permission_PERMISSION_LMS_EDIT Permission = 1001
	// Enables access to omni boss app.
	Permission_PERMISSION_OMNI_BOSS         Permission = 1200
	Permission_PERMISSION_OMNI_PORTALS_VIEW Permission = 1210
	// Enables access to viewing the integrations app.
	Permission_PERMISSION_INTEGRATIONS_VIEW Permission = 1300
	// Enables access to integrations payment menu options.
	Permission_PERMISSION_INTEGRATIONS_PAYMENT Permission = 1301
	// Enables access to integrations journey menu options.
	Permission_PERMISSION_INTEGRATIONS_JOURNEY Permission = 1302
	// Enables access to WFM app
	Permission_PERMISSION_WFM Permission = 1500
	// Enables access to Scorecards app.
	Permission_PERMISSION_SCORECARDS Permission = 1600
	// Enables access to managing scorecards.
	Permission_PERMISSION_SCORECARDS_MANAGE Permission = 1601
	// Enables access to evaluating scorecards.
	Permission_PERMISSION_SCORECARDS_EVALUATE Permission = 1602
	// Enables access to Dev Tools app.
	Permission_PERMISSION_DEV_TOOLS Permission = 1800
	// Enables access to view delivery notifications.
	Permission_PERMISSION_DELIVERY_NOTIFICATIONS_VIEW Permission = 2000
	// Enables access to create, update, or delete delivery notifications.
	Permission_PERMISSION_DELIVERY_NOTIFICATIONS_EDIT Permission = 2001
	// ACCESS the Tickets APP: Routing, Listing the tickets, dashboard, reports.
	Permission_PERMISSION_TICKETS_APP Permission = 3100
	// Adds Extra Access to: EnableProject
	Permission_PERMISSION_TICKETS_ADMIN Permission = 3101
	// Enables access to workflows builder
	Permission_PERMISSION_WORKFLOWS Permission = 4000
	// Enables access to view PBX Manager.
	Permission_PERMISSION_PBX_MANAGER_VIEW Permission = 4100
	// Enables access to create, update, or delete in PBX Manager.
	Permission_PERMISSION_PBX_MANAGER_EDIT Permission = 4101
)

func (Permission) Descriptor 

func (Permission) Descriptor() protoreflect.EnumDescriptor

func (Permission) Enum 

func (x Permission) Enum() *Permission

func (Permission) EnumDescriptor deprecated 

func (Permission) EnumDescriptor() ([]byte, []int)

Deprecated: Use Permission.Descriptor instead.

func (Permission) Number 

func (x Permission) Number() protoreflect.EnumNumber

func (Permission) String 

func (x Permission) String() string

func (Permission) Type 

func (Permission) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.