Skip to content

ChatClientOptions

Defined in: libs/ccs-chat-client/src/chat-client.ts:9

issuerUrl: string

Defined in: libs/ccs-chat-client/src/chat-client.ts:11

Identity Server v3 bare issuer origin, e.g. https://auth.centralcodestation.com (no /api).


clientId: string

Defined in: libs/ccs-chat-client/src/chat-client.ts:16

A CONFIDENTIAL client of your TENANT application with the client_credentials grant and a resource permission on chat-api (chat:sync, or the granular scopes it needs).


clientSecret: string

Defined in: libs/ccs-chat-client/src/chat-client.ts:18

Keep server-side only — never ship it to a browser.


chatApiUrl: string

Defined in: libs/ccs-chat-client/src/chat-client.ts:20

Chat API base URL, e.g. https://chat.centralcodestation.com/api/v1


resource: string

Defined in: libs/ccs-chat-client/src/chat-client.ts:22

RFC 8707 resource identifier of chat-api, e.g. https://chat.centralcodestation.com/api


optional scope?: string | ChatMachineScope[]

Defined in: libs/ccs-chat-client/src/chat-client.ts:28

The chat-api scopes to request. Default 'chat:sync'. Narrow it to the granular scopes the integration needs, e.g. ['chat:conversations.manage', 'chat:messages.send']. Each must be in the client’s grant on chat-api, else the token request fails with invalid_scope.


tenantId: string

Defined in: libs/ccs-chat-client/src/chat-client.ts:30

The client’s own tenant (Identity Server tenant id). Chat rejects any other (403).


applicationId: string

Defined in: libs/ccs-chat-client/src/chat-client.ts:32

The client’s own TENANT application id. Chat rejects any other (403).


optional fetch?: (input, init?) => Promise<Response>

Defined in: libs/ccs-chat-client/src/chat-client.ts:34

Override fetch (tests, runtimes without a global fetch).

string | URL | Request

RequestInit

Promise<Response>