CXoneAuth | nice-cxone-acd-agent-apps

Class to perform common authentication of user

Hierarchy

CXoneAuth

Index

Constructors

constructor

Properties

Accessors

Constructors

Private constructor

new CXoneAuth(): CXoneAuth

- Defined in auth-sdk/src/lib/cxone-auth.ts:76
constructor for CXoneAuth

Returns CXoneAuth

Properties

Private adminService

adminService: AdminService

authSettings

authSettings: AuthSettings = ...

Private authToken

authToken: AuthToken = ...

authTokenEmpty

authTokenEmpty: Subject<boolean> = ...

Private authWorker

authWorker: any

Private cxOneConfig

cxOneConfig: CXoneConfiguration = ...

Private cxoneUser

cxoneUser: CXoneUser = ...

Private isActiveImpersonatedUser

isActiveImpersonatedUser: boolean = false

Private logger

logger: Logger = ...

Private oidcConfig

oidcConfig: OpenIDConfiguration = ...

onAuthStatusChange

onAuthStatusChange: Subject<AuthResponse> = ...

Private securityHelper

securityHelper: SecurityHelper = ...

Private utilService

utilService: HttpUtilService = ...

Private validationUtils

validationUtils: ValidationUtils = ...

Static cxoneAuth

cxoneAuth: CXoneAuth

Accessors

isImpersonatedUser

get isImpersonatedUser(): boolean

- Defined in auth-sdk/src/lib/cxone-auth.ts:1307
Checks if instance is leader or not
example
```
const isImpersonatedUser = this.isActiveImpersonatedUser;
```
Returns boolean

Static instance

get instance(): CXoneAuth

- Defined in auth-sdk/src/lib/cxone-auth.ts:90
Method to create singleton object of the class
example
```
const authObject = CXoneAuth.instance;
```
Returns CXoneAuth

Methods

Private encryptToken

encryptToken(token: string, cryptoKey: CryptoKey): Promise<{ i: string; t: string }>

Encrypts a given token using the provided CryptoKey.

example

const token = "my-secret-token";
const cryptoKey = await crypto.subtle.generateKey(
  {
    name: "AES-GCM",
    length: 256,
  },
  true,
  ["encrypt", "decrypt"]
);
const encryptedToken = await encryptToken(token, cryptoKey);
this.logger.log(encryptedToken);
// Output: { t: "encryptedText", i: "initializationVector" }

Parameters

token: string

The token to be encrypted.
cryptoKey: CryptoKey

The CryptoKey used for encryption.

Returns Promise<{ i: string; t: string }>

A promise that resolves to a JSONWebKey containing the encrypted token and initialization vector.

Private generateAndStoreCryptoKey

generateAndStoreCryptoKey(userId: string): Promise<CryptoKey>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1493
Generates a cryptographic key, encrypts it, and stores it in local storage.
example
```
const cryptoKey = await this.generateAndStoreCryptoKey('user123');
```
Parameters
- userId: string
  
  The user ID used to derive the secondary encryption key.
Returns Promise<CryptoKey>
A promise that resolves to the generated CryptoKey.

getAccessTokenByCode

getAccessTokenByCode(authWithCodeReq: AuthWithCodeReq): Promise<AuthToken>

- Defined in auth-sdk/src/lib/cxone-auth.ts:191
Method to generate the access token and call the getCXoneConfiguration method in the response to get the api endpoint url from the cxone configuration.
example
```
getAccessTokenByCode({'Salesforce Agent Cons..', 'eyJ0eXAiOiJKV1Qi...'})
```
Parameters
- authWithCodeReq: AuthWithCodeReq
  
  request object containing client id & generated code after authenticate
Returns Promise<AuthToken>
- returns the auth token

getAccessTokenByToken

getAccessTokenByToken(authWithTokenReq: AuthWithTokenReq): Promise<AuthToken>

- Defined in auth-sdk/src/lib/cxone-auth.ts:319
method to generate new token using existing token
example
```
getAccessTokenByToken({'http:testhost.com', 'eyJ0eXAiOiJKV1Qi...'});
```
Parameters
- authWithTokenReq: AuthWithTokenReq
  
  request object containing host url and existing access token
Returns Promise<AuthToken>
- returns the auth token

Private getAcdAuthorizationTokenEndpoint

getAcdAuthorizationTokenEndpoint(icClusterId: string, domain: string): string

- Defined in auth-sdk/src/lib/cxone-auth.ts:704
This method returns the Authorization Token Endpoint
example
```
getAcdAuthorizationTokenEndpoint('SC11','ucnlabext.com');
```
Parameters
- icClusterId: string
  
  icClusterId
- domain: string
  
  domain
Returns string
- api end point

getAuthState

getAuthState(): AuthState

- Defined in auth-sdk/src/lib/cxone-auth.ts:905
Checks if user is logged in and have valid token
example
```
const userLoginDetails = this.getAuthState();
```
Returns AuthState
- user login details with auth token

getAuthToken

getAuthToken(): AuthToken

- Defined in auth-sdk/src/lib/cxone-auth.ts:853
example
```
const authToken = this.getAuthToken();
```
Returns AuthToken
- returns auth token object

getAuthorizeUrl

getAuthorizeUrl(displayMode: string, codeChallengeMethod: string, tenantId?: string): Promise<string>

- Defined in auth-sdk/src/lib/cxone-auth.ts:132
Method generate the Authorize url using authorize endpoint with clientId, code challenge, authMode and codeChallengeMethod. This url will be use to open the login screen in page or popup window based on the display value.
example
```
getAuthorizeUrl('page', 'S256');
```
Parameters
- displayMode: string
  
  get the authmode, whether page or popup
- codeChallengeMethod: string
  
  'S256'
- Optional tenantId: string
Returns Promise<string>
authUrl

getBrandingProfile

getBrandingProfile(): Promise<CXoneSdkError | BrandingProfile>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1232
Method to return branding profiles

Returns Promise<CXoneSdkError | BrandingProfile>
- returns the branding profiles
```
@example
getBrandingProfile()
```

getBusinessUnit

getBusinessUnit(): Promise<CXoneSdkError | BusinessUnit>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1196
Method to return business unit features

Returns Promise<CXoneSdkError | BusinessUnit>
- returns the business unit features
```
@example
getBusinessUnit()
```

getCXoneConfig

getCXoneConfig(): CXoneConfiguration

- Defined in auth-sdk/src/lib/cxone-auth.ts:887
example
```
const cxoneConfig = this.getCXoneConfig();
```
Returns CXoneConfiguration
- cxone configuration object

getCXoneConfiguration

getCXoneConfiguration(hostname: string, tenantId: string, isUserHub: boolean): Promise<CXoneSdkError | CXoneConfiguration>

- Defined in auth-sdk/src/lib/cxone-auth.ts:605
This method is to get CXone Configurations for authentication purpose

Parameters
- hostname: string
- tenantId: string
  tenantId
```
@example
getCXoneConfiguration('https://cxone.dev.niceincontact.com','11e85da0-f32c-7e10-898c-0242ac110003');
```
- isUserHub: boolean
Returns Promise<CXoneSdkError | CXoneConfiguration>
- Http Response from well known cxone config api

Private getCryptoKey

getCryptoKey(userId: string, encryptedKey: string, iv: string): Promise<CryptoKey>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1456
Retrieves a CryptoKey by decrypting an encrypted key using a derived key.
example
```
const cryptoKey = await this.getCryptoKey('user123', 'encryptedKeyString', 'initializationVector');
```
Parameters
- userId: string
  
  The user ID used to derive the secondary key.
- encryptedKey: string
  
  The encrypted key that needs to be decrypted.
- iv: string
  
  The initialization vector used for decryption.
Returns Promise<CryptoKey>
A promise that resolves to a CryptoKey.

getDecryptedToken

getDecryptedToken(): Promise<AuthToken>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1553
Retrieves and decrypts the authentication token stored in local storage.
throws
If an error occurs during the decryption process.

remarks
This method retrieves the encrypted authentication token, encrypted key, and user information from local storage. It then attempts to decrypt the token using the retrieved information. If any required information is missing or decryption fails, the method returns null.

example
```
const decryptedToken = await authSdk.getDecryptedToken();
```
Returns Promise<AuthToken>
A promise that resolves to the decrypted authentication token, or null if decryption fails.

getImpersonatingUser

getImpersonatingUser(token: string): any

- Defined in auth-sdk/src/lib/cxone-auth.ts:1291
Check if token is impersonated token
example
```
getImpersonatingUser(token)
```
Parameters
- token: string
  
  token
Returns any

Private getJWKS

getJWKS(): Promise<JWKS>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1356
Method to get JWKS for verifing jwt token
example
```
const response = await this.getJWKS();
```
Returns Promise<JWKS>
- Http Response form jwks endpoint

getOpenIDConfiguration

getOpenIDConfiguration(hostname: string): Promise<OpenIDConfiguration>

- Defined in auth-sdk/src/lib/cxone-auth.ts:545
Method to get discovery endpoints for authentication purposes
example
```
getOpenIDConfiguration('https://cxone.dev.niceincontact.com')
```
Parameters
- hostname: string
Returns Promise<OpenIDConfiguration>
- Http Response form well known openid config api

Private getOrGenerateCryptoKey

getOrGenerateCryptoKey(userId: string): Promise<CryptoKey>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1473
Retrieves or generates a cryptographic key for the specified user.
example
```
const cryptoKey = await this.getOrGenerateCryptoKey('user123');
```
Parameters
- userId: string
  
  The ID of the user for whom the cryptographic key is being retrieved or generated.
Returns Promise<CryptoKey>
A promise that resolves to the cryptographic key.

getPermissions

getPermissions(): Promise<CXoneSdkError | Permissions[]>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1220
Method to return business unit features

Returns Promise<CXoneSdkError | Permissions[]>
- returns the business unit features
```
@example
getBusinessUnit()
```

Private getRefreshToken

getRefreshToken(): Promise<void>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1014
Used to fetch the new access token when the old token is expired the authentication end point we will get from localstorage object 'discovery_response'

Returns Promise<void>

getRegionalAccessTokenByToken

getRegionalAccessTokenByToken(authWithTokenReq: AuthWithTokenReq, impersonatingUser: any): Promise<AuthToken>

- Defined in auth-sdk/src/lib/cxone-auth.ts:428
method to generate new token using existing token using regional token exchange service
example
```
getRegionalAccessTokenByToken({'http:testhost.com', 'eyJ0eXAiOiJKV1Qi...'}, {name:'test'});
```
Parameters
- authWithTokenReq: AuthWithTokenReq
  
  request object containing host url and existing access token
- impersonatingUser: any
  
  impersonating user details
Returns Promise<AuthToken>
- returns the auth token

Private getRegionalRefreshToken

getRegionalRefreshToken(): Promise<void>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1083
Used to fetch the new access token using regional token endpoint when the old token is expired

Returns Promise<void>

getUserDetails

getUserDetails(): Promise<CXoneSdkError | CXoneUserDetails>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1208
Method to return active user details

Returns Promise<CXoneSdkError | CXoneUserDetails>
- returns the active user details
```
@example
getUserDetails()
```

Private getUserManagementDetails

getUserManagementDetails(): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:1397
Fetch the user details of logged in user
example
```
getUserManagementDetails();
```
Returns void

Private getWhoAmIData

getWhoAmIData(authToken: AuthToken): Promise<WhoamiResponse>

- Defined in auth-sdk/src/lib/cxone-auth.ts:653
Method to get the whoami api response
example
```
getWhoAmIData(authToken)
```
Parameters
- authToken: AuthToken
  
  'authToken'
Returns Promise<WhoamiResponse>
- Http Response from whoAmI api

init

init(authSettings: AuthSettings): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:104
example
```
init({'cxoneHostname': 'https://cxone.dev.niceincontact.com', 'clientId': 'Salesforce Agent Console@inContact Inc.'})
```
Parameters
- authSettings: AuthSettings
  
  initialize the auth settings
Returns void

Private initUtilWorker

initUtilWorker(): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:1005
Use to initializing the util worker and will return the method inside the worker
example
```
this.initUtilWorker();
```
Returns void

isTokenExpired

isTokenExpired(): boolean

- Defined in auth-sdk/src/lib/cxone-auth.ts:938
Method to check token is expired or not
example
```
const isExpired = this.isTokenExpired();
```
Returns boolean
- boolean value token is expired or not

launchCXoneAgent

launchCXoneAgent(targetDivId: string, appUrl: string, styleParams: {}): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:1253
Method to launch CXoneAgent application from SDK
example
```
launchCXoneAgent('divId','https://cxagent.nicecxone-dev.com?src=UH',{width:'400px', height:'500px'});
```
Parameters
- targetDivId: string
  
  Target div id wherein application needs to be loaded
- appUrl: string
  
  Application url that needs to be launched
- styleParams: {}
  
  css style params to be applied to iframe
  - [key: string]: string
Returns void

parseAndSaveAuthToken

parseAndSaveAuthToken(authToken: HttpResponse, setUserInfo?: boolean, impersonatingUser?: any): AuthToken

- Defined in auth-sdk/src/lib/cxone-auth.ts:793
Method used to parse the auth token, user info and store the values to local storage
example
```
parseAndSaveAuthToken(authToken, true, impersonatingUser);
```
Parameters
- authToken: HttpResponse
  
  authToken response
- setUserInfo: boolean = true
  
  flag to decide whether to set user info or not
- Optional impersonatingUser: any
  
  impersonating user details
Returns AuthToken
- parsed authToken data

Private postAuthCodeMessage

postAuthCodeMessage(event: MessageEvent<any>): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:1271
Event handler to receive message event from auth callback popup
example
```
postAuthCodeMessage(eventData)
```
Parameters
- event: MessageEvent<any>
Returns void

restoreData

restoreData(authTokenFromLeader?: AuthToken): Promise<void>

- Defined in auth-sdk/src/lib/cxone-auth.ts:725
restores data and re-initiates auth flow
example
```
this.restoreData();
```
Parameters
- Optional authTokenFromLeader: AuthToken
Returns Promise<void>
- re-initialization status for auth flow as authenticated/not authenticated through onAuthStatusChange subject

setAuthAndUserData

setAuthAndUserData(authToken: AuthToken, setUserInfo?: boolean, userDetails?: any): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:816
Method used to process parsed auth token and set user info object
example
```
setAuthAndUserData(authToken, true, userDetails);
```
Parameters
- authToken: AuthToken
  
  parsed authToken
- setUserInfo: boolean = true
  
  flag to decide whether to set user info or not
- Optional userDetails: any
  
  user details
Returns void
- parsed authToken data

setAuthToken

setAuthToken(authToken: AuthToken): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:842
example
```
this.setAuthToken(authToken);
```
Parameters
- authToken: AuthToken
  
  authToken object
Returns void

setCXoneConfig

setCXoneConfig(cxoneConfig: CXoneConfiguration): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:876
example
```
setConfig(cxoneConfig: CXoneConfiguration);
```
Parameters
- cxoneConfig: CXoneConfiguration
  
  cxone configuration object
Returns void

setEncryptedAuthToken

setEncryptedAuthToken(authToken: AuthToken): Promise<void | CXoneSdkError>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1423
Encrypts the provided authentication token and stores it in local storage.
throws
Will log an error to the console if there is an issue during the encryption or storage process.

example
```
await this.setEncryptedAuthToken(authToken);
```
Parameters
- authToken: AuthToken
  
  The authentication token to be encrypted and stored.
Returns Promise<void | CXoneSdkError>
A promise that resolves when the token has been successfully encrypted and stored.

startRefreshTokenCheck

startRefreshTokenCheck(authToken: AuthToken, isLeader: boolean, isTokenValid: boolean): boolean

- Defined in auth-sdk/src/lib/cxone-auth.ts:961
Used to start the check for refresh token Here, first we will initiate the worker which have a timeout, this timeout will get triggered based on the expiry time of the token we have passed Once the expiry time is reached the worker will execute the callback to get the refresh token that we have passed
example
```
startRefreshTokenCheck(authToken, true);
```
Parameters
- authToken: AuthToken
  
  token object which will have refresh token and the expire in detail required to obtain the new token
- isLeader: boolean
  
  defines if instance is leader or not
- isTokenValid: boolean
Returns boolean

Private subscribeEmptyAuthToken

subscribeEmptyAuthToken(): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:768
Subscription for empty auth token

Returns void

Private subscribeResponseMessage

subscribeResponseMessage(): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:757
Subscription for response message over broadcast channel

Returns void

terminateCXoneUtilWorker

terminateCXoneUtilWorker(): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:1175
Method to terminate util worker
example
```
terminateCXoneUtilWorker()
```
Returns void

terminateUtilWorker

terminateUtilWorker(): void

- Defined in auth-sdk/src/lib/cxone-auth.ts:1163
Use to terminate the util worker instance
example
```
this.terminateUtilWorker();
```
Returns void

validateFTAndSetAuthToken

validateFTAndSetAuthToken(authToken: AuthToken, reject?: (() => void)): Promise<void>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1617
Method to check Ft and save auth token

example
validateFTAndSetAuthToken(authToken)

Parameters
- authToken: AuthToken
  
  authToken to be saved
- Optional reject: (() => void)
  - - (): void
    - Returns void
Returns Promise<void>

validateFtAndGetDecryptedToken

validateFtAndGetDecryptedToken(): Promise<AuthToken>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1593
Validates if the feature toggle for token encryption is enabled and retrieves the decrypted token.
example
```
const decryptedToken = await this.validateFtAndGetDecryptedToken();
```
Returns Promise<AuthToken>
A promise that resolves to the decrypted authentication token, or null if decryption fails or the feature toggle is disabled.

Private verifyJwt

verifyJwt(authResponse: HttpResponse): Promise<boolean>

- Defined in auth-sdk/src/lib/cxone-auth.ts:1320
Method to verify JWT
example
```
const user = await verifyJwt(authResponse)
```
Parameters
- authResponse: HttpResponse
Returns Promise<boolean>
- verified payload

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Returns CXoneAuth

Properties

Private adminService

authSettings

Private authToken

authTokenEmpty

Private authWorker

Private cxOneConfig

Private cxoneUser

Private isActiveImpersonatedUser

Private logger

Private oidcConfig

onAuthStatusChange

Private securityHelper

Private utilService

Private validationUtils

Static cxoneAuth

Accessors

isImpersonatedUser

Returns boolean

Static instance

Returns CXoneAuth

Methods

Private encryptToken

Parameters

token: string

cryptoKey: CryptoKey

Returns Promise<{ i: string; t: string }>

Private generateAndStoreCryptoKey

Parameters

userId: string

Returns Promise<CryptoKey>

getAccessTokenByCode

Parameters

authWithCodeReq: AuthWithCodeReq

Returns Promise<AuthToken>

getAccessTokenByToken

Parameters

authWithTokenReq: AuthWithTokenReq

Returns Promise<AuthToken>

Private getAcdAuthorizationTokenEndpoint

Parameters

icClusterId: string

domain: string

Returns string

getAuthState

Returns AuthState

getAuthToken

Returns AuthToken

getAuthorizeUrl

Parameters

displayMode: string

codeChallengeMethod: string

Optional tenantId: string

Returns Promise<string>

getBrandingProfile

Returns Promise<CXoneSdkError | BrandingProfile>

getBusinessUnit

Returns Promise<CXoneSdkError | BusinessUnit>

getCXoneConfig

Returns CXoneConfiguration

getCXoneConfiguration

Parameters

hostname: string

tenantId: string

isUserHub: boolean

Returns Promise<CXoneSdkError | CXoneConfiguration>

Private getCryptoKey

Parameters

userId: string

encryptedKey: string

iv: string