Interface ClientInterface

Client entity interface

Mirrors macs-node-sdk/lib/clients/models/client.js. A Client is an OAuth / API-key credential owned by an org or user. secret and refresh_key are server-managed and never returned on reads.

interface ClientInterface {
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    org?: string;
    user?: string;
    name: string;
    oauth?: ClientOAuthConfig;
    active?: boolean;
    tags?: string[];
}

Hierarchy (View Summary)

Properties

external_id? extensors? record_history? id? org? user? name oauth? active? tags?

Properties

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionalorg

org?: string

Optionaluser

user?: string

name

name: string

Client name (required, regex [a-zA-Z0-9_:-]+). Used as the OAuth client_id.

Optionaloauth

oauth?: ClientOAuthConfig

OAuth configuration (nested)

Optionalactive

active?: boolean

Whether the entity is active

Optionaltags

tags?: string[]

Settings

Member Visibility

On This Page

Properties