Constructors constructor
+
AdminApiClient | @camunda8/sdk Constructors constructor new ( options ? ) : AdminApiClient Parameters Optional options : { config ?: DeepPartial < { CAMUNDA_CONSOLE_BASE_URL : undefined | string ; CAMUNDA_CONSOLE_CLIENT_ID : undefined | string ; CAMUNDA_CONSOLE_CLIENT_SECRET : undefined | string ; CAMUNDA_CONSOLE_OAUTH_AUDIENCE : string ; CAMUNDA_CUSTOM_CERT_CHAIN_PATH : undefined | string ; CAMUNDA_CUSTOM_PRIVATE_KEY_PATH : undefined | string ; CAMUNDA_CUSTOM_ROOT_CERT_PATH : undefined | string ; CAMUNDA_CUSTOM_USER_AGENT_STRING : undefined | string ; CAMUNDA_MODELER_BASE_URL : string ; CAMUNDA_MODELER_OAUTH_AUDIENCE : undefined | string ; CAMUNDA_OAUTH_DISABLED : boolean ; CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS : number ; CAMUNDA_OAUTH_URL : undefined | string ; CAMUNDA_OPERATE_BASE_URL : undefined | string ; CAMUNDA_OPERATE_OAUTH_AUDIENCE : string ; CAMUNDA_OPTIMIZE_BASE_URL : undefined | string ; CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE : string ; CAMUNDA_SECURE_CONNECTION : boolean ; CAMUNDA_TASKLIST_BASE_URL : undefined | string ; CAMUNDA_TASKLIST_OAUTH_AUDIENCE : string ; CAMUNDA_TENANT_ID : undefined | string ; CAMUNDA_TOKEN_CACHE_DIR : undefined | string ; CAMUNDA_TOKEN_DISK_CACHE_DISABLE : boolean ; CAMUNDA_TOKEN_SCOPE : undefined | string ; CAMUNDA_ZEEBE_OAUTH_AUDIENCE : string ; ZEEBE_ADDRESS : string ; ZEEBE_CLIENT_ID : undefined | string ; ZEEBE_CLIENT_SECRET : undefined | string ; zeebeGrpcSettings : { GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA : number ; GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS : number ; GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS : number ; GRPC_INITIAL_RECONNECT_BACKOFF_MS : string | number ; GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS : number ; GRPC_KEEPALIVE_TIMEOUT_MS : number ; GRPC_KEEPALIVE_TIME_MS : number ; GRPC_MAX_RECONNECT_BACKOFF_MS : string | number ; GRPC_MIN_RECONNECT_BACKOFF_MS : string | number ; ZEEBE_CLIENT_LOG_LEVEL : string ; ZEEBE_CLIENT_LOG_TYPE : string ; ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS : number ; ZEEBE_GRPC_CLIENT_EAGER_CONNECT : boolean ; ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS : undefined | number ; ZEEBE_GRPC_CLIENT_MAX_RETRIES : number ; ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS : number ; ZEEBE_GRPC_CLIENT_RETRY : boolean ; ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS : number ; ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS : number ; } ; } > ; oAuthProvider ?: IOAuthProvider ; } Optional config ?: DeepPartial < { CAMUNDA_CONSOLE_BASE_URL : undefined | string ; CAMUNDA_CONSOLE_CLIENT_ID : undefined | string ; CAMUNDA_CONSOLE_CLIENT_SECRET : undefined | string ; CAMUNDA_CONSOLE_OAUTH_AUDIENCE : string ; CAMUNDA_CUSTOM_CERT_CHAIN_PATH : undefined | string ; CAMUNDA_CUSTOM_PRIVATE_KEY_PATH : undefined | string ; CAMUNDA_CUSTOM_ROOT_CERT_PATH : undefined | string ; CAMUNDA_CUSTOM_USER_AGENT_STRING : undefined | string ; CAMUNDA_MODELER_BASE_URL : string ; CAMUNDA_MODELER_OAUTH_AUDIENCE : undefined | string ; CAMUNDA_OAUTH_DISABLED : boolean ; CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS : number ; CAMUNDA_OAUTH_URL : undefined | string ; CAMUNDA_OPERATE_BASE_URL : undefined | string ; CAMUNDA_OPERATE_OAUTH_AUDIENCE : string ; CAMUNDA_OPTIMIZE_BASE_URL : undefined | string ; CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE : string ; CAMUNDA_SECURE_CONNECTION : boolean ; CAMUNDA_TASKLIST_BASE_URL : undefined | string ; CAMUNDA_TASKLIST_OAUTH_AUDIENCE : string ; CAMUNDA_TENANT_ID : undefined | string ; CAMUNDA_TOKEN_CACHE_DIR : undefined | string ; CAMUNDA_TOKEN_DISK_CACHE_DISABLE : boolean ; CAMUNDA_TOKEN_SCOPE : undefined | string ; CAMUNDA_ZEEBE_OAUTH_AUDIENCE : string ; ZEEBE_ADDRESS : string ; ZEEBE_CLIENT_ID : undefined | string ; ZEEBE_CLIENT_SECRET : undefined | string ; zeebeGrpcSettings : { GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA : number ; GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS : number ; GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS : number ; GRPC_INITIAL_RECONNECT_BACKOFF_MS : string | number ; GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS : number ; GRPC_KEEPALIVE_TIMEOUT_MS : number ; GRPC_KEEPALIVE_TIME_MS : number ; GRPC_MAX_RECONNECT_BACKOFF_MS : string | number ; GRPC_MIN_RECONNECT_BACKOFF_MS : string | number ; ZEEBE_CLIENT_LOG_LEVEL : string ; ZEEBE_CLIENT_LOG_TYPE : string ; ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS : number ; ZEEBE_GRPC_CLIENT_EAGER_CONNECT : boolean ; ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS : undefined | number ; ZEEBE_GRPC_CLIENT_MAX_RETRIES : number ; ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS : number ; ZEEBE_GRPC_CLIENT_RETRY : boolean ; ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS : number ; ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS : number ; } ; } > Properties Private user user : string
Methods create create ( req ) : Promise < CreatedClusterClient > Parameters req : { clientName : string ; clusterUuid : string ; permissions : string [] ; } client : string cluster : string permissions : string [] create create ( createClusterRequest ) : Promise < { clusterId : string ; } > Returns Promise < { clusterId : string ; } > create create ( email , orgRoles ) : Promise < null > Returns Promise < null > create create ( __namedParameters ) : Promise < null > Parameters __namedParameters : { clusterUuid : string ; secretName : string ; secretValue : string ; } cluster : string secret : string secret : string Returns Promise < null > delete delete ( clusterUuid , clientId ) : Promise < null > Parameters clusterUuid : string clientId : string Returns Promise < null > delete delete ( clusterUuid ) : Promise < null > Returns Promise < null > delete delete ( email ) : Promise < null > Returns Promise < null > delete delete ( clusterUuid , secretName ) : Promise < null > Parameters clusterUuid : string secretName : string Returns Promise < null > Constructors constructor new ( options ? ) : AdminApiClient Parameters Optional options : { config ?: DeepPartial < { CAMUNDA_CONSOLE_BASE_URL : undefined | string ; CAMUNDA_CONSOLE_CLIENT_ID : undefined | string ; CAMUNDA_CONSOLE_CLIENT_SECRET : undefined | string ; CAMUNDA_CONSOLE_OAUTH_AUDIENCE : string ; CAMUNDA_CUSTOM_CERT_CHAIN_PATH : undefined | string ; CAMUNDA_CUSTOM_PRIVATE_KEY_PATH : undefined | string ; CAMUNDA_CUSTOM_ROOT_CERT_PATH : undefined | string ; CAMUNDA_CUSTOM_USER_AGENT_STRING : undefined | string ; CAMUNDA_MODELER_BASE_URL : string ; CAMUNDA_MODELER_OAUTH_AUDIENCE : undefined | string ; CAMUNDA_OAUTH_DISABLED : boolean ; CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS : number ; CAMUNDA_OAUTH_URL : undefined | string ; CAMUNDA_OPERATE_BASE_URL : undefined | string ; CAMUNDA_OPERATE_OAUTH_AUDIENCE : string ; CAMUNDA_OPTIMIZE_BASE_URL : undefined | string ; CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE : string ; CAMUNDA_SECURE_CONNECTION : boolean ; CAMUNDA_TASKLIST_BASE_URL : undefined | string ; CAMUNDA_TASKLIST_OAUTH_AUDIENCE : string ; CAMUNDA_TENANT_ID : undefined | string ; CAMUNDA_TOKEN_CACHE_DIR : undefined | string ; CAMUNDA_TOKEN_DISK_CACHE_DISABLE : boolean ; CAMUNDA_TOKEN_SCOPE : undefined | string ; CAMUNDA_ZEEBE_OAUTH_AUDIENCE : string ; ZEEBE_ADDRESS : string ; ZEEBE_CLIENT_ID : undefined | string ; ZEEBE_CLIENT_SECRET : undefined | string ; zeebeGrpcSettings : { GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA : number ; GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS : number ; GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS : number ; GRPC_INITIAL_RECONNECT_BACKOFF_MS : string | number ; GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS : number ; GRPC_KEEPALIVE_TIMEOUT_MS : number ; GRPC_KEEPALIVE_TIME_MS : number ; GRPC_MAX_RECONNECT_BACKOFF_MS : string | number ; GRPC_MIN_RECONNECT_BACKOFF_MS : string | number ; ZEEBE_CLIENT_LOG_LEVEL : string ; ZEEBE_CLIENT_LOG_TYPE : string ; ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS : number ; ZEEBE_GRPC_CLIENT_EAGER_CONNECT : boolean ; ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS : undefined | number ; ZEEBE_GRPC_CLIENT_MAX_RETRIES : number ; ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS : number ; ZEEBE_GRPC_CLIENT_RETRY : boolean ; ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS : number ; ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS : number ; } ; } > ; oAuthProvider ?: IOAuthProvider ; } Optional config ?: DeepPartial < { CAMUNDA_CONSOLE_BASE_URL : undefined | string ; CAMUNDA_CONSOLE_CLIENT_ID : undefined | string ; CAMUNDA_CONSOLE_CLIENT_SECRET : undefined | string ; CAMUNDA_CONSOLE_OAUTH_AUDIENCE : string ; CAMUNDA_CUSTOM_CERT_CHAIN_PATH : undefined | string ; CAMUNDA_CUSTOM_PRIVATE_KEY_PATH : undefined | string ; CAMUNDA_CUSTOM_ROOT_CERT_PATH : undefined | string ; CAMUNDA_CUSTOM_USER_AGENT_STRING : undefined | string ; CAMUNDA_MODELER_BASE_URL : string ; CAMUNDA_MODELER_OAUTH_AUDIENCE : undefined | string ; CAMUNDA_OAUTH_DISABLED : boolean ; CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS : number ; CAMUNDA_OAUTH_URL : undefined | string ; CAMUNDA_OPERATE_BASE_URL : undefined | string ; CAMUNDA_OPERATE_OAUTH_AUDIENCE : string ; CAMUNDA_OPTIMIZE_BASE_URL : undefined | string ; CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE : string ; CAMUNDA_SECURE_CONNECTION : boolean ; CAMUNDA_TASKLIST_BASE_URL : undefined | string ; CAMUNDA_TASKLIST_OAUTH_AUDIENCE : string ; CAMUNDA_TENANT_ID : undefined | string ; CAMUNDA_TOKEN_CACHE_DIR : undefined | string ; CAMUNDA_TOKEN_DISK_CACHE_DISABLE : boolean ; CAMUNDA_TOKEN_SCOPE : undefined | string ; CAMUNDA_ZEEBE_OAUTH_AUDIENCE : string ; ZEEBE_ADDRESS : string ; ZEEBE_CLIENT_ID : undefined | string ; ZEEBE_CLIENT_SECRET : undefined | string ; zeebeGrpcSettings : { GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA : number ; GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS : number ; GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS : number ; GRPC_INITIAL_RECONNECT_BACKOFF_MS : string | number ; GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS : number ; GRPC_KEEPALIVE_TIMEOUT_MS : number ; GRPC_KEEPALIVE_TIME_MS : number ; GRPC_MAX_RECONNECT_BACKOFF_MS : string | number ; GRPC_MIN_RECONNECT_BACKOFF_MS : string | number ; ZEEBE_CLIENT_LOG_LEVEL : string ; ZEEBE_CLIENT_LOG_TYPE : string ; ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS : number ; ZEEBE_GRPC_CLIENT_EAGER_CONNECT : boolean ; ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS : undefined | number ; ZEEBE_GRPC_CLIENT_MAX_RETRIES : number ; ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS : number ; ZEEBE_GRPC_CLIENT_RETRY : boolean ; ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS : number ; ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS : number ; } ; } > Properties Private user user : string
Methods create create ( req ) : Promise < CreatedClusterClient > Parameters req : { clientName : string ; clusterUuid : string ; permissions : string [] ; } client : string cluster : string permissions : string [] create create ( createClusterRequest ) : Promise < { clusterId : string ; } > Returns Promise < { clusterId : string ; } > create create ( email , orgRoles ) : Promise < null > Returns Promise < null > create create ( __namedParameters ) : Promise < null > Parameters __namedParameters : { clusterUuid : string ; secretName : string ; secretValue : string ; } cluster : string secret : string secret : string Returns Promise < null > delete delete ( clusterUuid , clientId ) : Promise < null > Parameters clusterUuid : string clientId : string Returns Promise < null > delete delete ( clusterUuid ) : Promise < null > Returns Promise < null > delete delete ( email ) : Promise < null > Returns Promise < null > delete delete ( clusterUuid , secretName ) : Promise < null > Parameters clusterUuid : string secretName : string Returns Promise < null > Private get get ( ) : Promise < { accept : string ; authorization : string ; content-type : string ; user-agent : string ; } > Returns Promise < { accept : string ; authorization : string ; content-type : string ; user-agent : string ; } > get get ( clusterUuid ) : Promise < { [key : string ]: string ; } > Returns Promise < { [key : string ]: string ; } > whitelistIPs whitelistIPs ( clusterUuid , ipwhitelist ) : Promise < unknown > Parameters clusterUuid : string ipwhitelist : [ { description : string ; ip : string ; } ] Returns Promise < unknown >
\ No newline at end of file
+
Private get get ( ) : Promise < { accept : string ; authorization : string ; content-type : string ; user-agent : string ; } > Returns Promise < { accept : string ; authorization : string ; content-type : string ; user-agent : string ; } > get get ( clusterUuid ) : Promise < { [key : string ]: string ; } > Returns Promise < { [key : string ]: string ; } > whitelistIPs whitelistIPs ( clusterUuid , ipwhitelist ) : Promise < unknown > Parameters clusterUuid : string ipwhitelist : [ { description : string ; ip : string ; } ] Returns Promise < unknown >
\ No newline at end of file
diff --git a/classes/index.Auth.NullAuthProvider.html b/classes/index.Auth.NullAuthProvider.html
index 65aa57a8..489f0aa1 100644
--- a/classes/index.Auth.NullAuthProvider.html
+++ b/classes/index.Auth.NullAuthProvider.html
@@ -1,3 +1,3 @@
-
NullAuthProvider | @camunda8/sdk Constructors constructor
+
NullAuthProvider | @camunda8/sdk Methods get get ( audience ) : Promise < string > Returns Promise < string >
\ No newline at end of file
+
Methods get get ( audience ) : Promise < string > Returns Promise < string >
\ No newline at end of file
diff --git a/classes/index.Auth.OAuthProvider.html b/classes/index.Auth.OAuthProvider.html
index cc561f39..f81e58b0 100644
--- a/classes/index.Auth.OAuthProvider.html
+++ b/classes/index.Auth.OAuthProvider.html
@@ -1,4 +1,4 @@
-
OAuthProvider | @camunda8/sdk Constructors constructor
+
OAuthProvider | @camunda8/sdk Constructors constructor new OAuth ( options ? ) : OAuthProvider Parameters Optional options : { config ?: DeepPartial < { CAMUNDA_CONSOLE_BASE_URL : undefined | string ; CAMUNDA_CONSOLE_CLIENT_ID : undefined | string ; CAMUNDA_CONSOLE_CLIENT_SECRET : undefined | string ; CAMUNDA_CONSOLE_OAUTH_AUDIENCE : string ; CAMUNDA_CUSTOM_CERT_CHAIN_PATH : undefined | string ; CAMUNDA_CUSTOM_PRIVATE_KEY_PATH : undefined | string ; CAMUNDA_CUSTOM_ROOT_CERT_PATH : undefined | string ; CAMUNDA_CUSTOM_USER_AGENT_STRING : undefined | string ; CAMUNDA_MODELER_BASE_URL : string ; CAMUNDA_MODELER_OAUTH_AUDIENCE : undefined | string ; CAMUNDA_OAUTH_DISABLED : boolean ; CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS : number ; CAMUNDA_OAUTH_URL : undefined | string ; CAMUNDA_OPERATE_BASE_URL : undefined | string ; CAMUNDA_OPERATE_OAUTH_AUDIENCE : string ; CAMUNDA_OPTIMIZE_BASE_URL : undefined | string ; CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE : string ; CAMUNDA_SECURE_CONNECTION : boolean ; CAMUNDA_TASKLIST_BASE_URL : undefined | string ; CAMUNDA_TASKLIST_OAUTH_AUDIENCE : string ; CAMUNDA_TENANT_ID : undefined | string ; CAMUNDA_TOKEN_CACHE_DIR : undefined | string ; CAMUNDA_TOKEN_DISK_CACHE_DISABLE : boolean ; CAMUNDA_TOKEN_SCOPE : undefined | string ; CAMUNDA_ZEEBE_OAUTH_AUDIENCE : string ; ZEEBE_ADDRESS : string ; ZEEBE_CLIENT_ID : undefined | string ; ZEEBE_CLIENT_SECRET : undefined | string ; zeebeGrpcSettings : { GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA : number ; GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS : number ; GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS : number ; GRPC_INITIAL_RECONNECT_BACKOFF_MS : string | number ; GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS : number ; GRPC_KEEPALIVE_TIMEOUT_MS : number ; GRPC_KEEPALIVE_TIME_MS : number ; GRPC_MAX_RECONNECT_BACKOFF_MS : string | number ; GRPC_MIN_RECONNECT_BACKOFF_MS : string | number ; ZEEBE_CLIENT_LOG_LEVEL : string ; ZEEBE_CLIENT_LOG_TYPE : string ; ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS : number ; ZEEBE_GRPC_CLIENT_EAGER_CONNECT : boolean ; ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS : undefined | number ; ZEEBE_GRPC_CLIENT_MAX_RETRIES : number ; ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS : number ; ZEEBE_GRPC_CLIENT_RETRY : boolean ; ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS : number ; ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS : number ; } ; } > ; } Optional config ?: DeepPartial < { CAMUNDA_CONSOLE_BASE_URL : undefined | string ; CAMUNDA_CONSOLE_CLIENT_ID : undefined | string ; CAMUNDA_CONSOLE_CLIENT_SECRET : undefined | string ; CAMUNDA_CONSOLE_OAUTH_AUDIENCE : string ; CAMUNDA_CUSTOM_CERT_CHAIN_PATH : undefined | string ; CAMUNDA_CUSTOM_PRIVATE_KEY_PATH : undefined | string ; CAMUNDA_CUSTOM_ROOT_CERT_PATH : undefined | string ; CAMUNDA_CUSTOM_USER_AGENT_STRING : undefined | string ; CAMUNDA_MODELER_BASE_URL : string ; CAMUNDA_MODELER_OAUTH_AUDIENCE : undefined | string ; CAMUNDA_OAUTH_DISABLED : boolean ; CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS : number ; CAMUNDA_OAUTH_URL : undefined | string ; CAMUNDA_OPERATE_BASE_URL : undefined | string ; CAMUNDA_OPERATE_OAUTH_AUDIENCE : string ; CAMUNDA_OPTIMIZE_BASE_URL : undefined | string ; CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE : string ; CAMUNDA_SECURE_CONNECTION : boolean ; CAMUNDA_TASKLIST_BASE_URL : undefined | string ; CAMUNDA_TASKLIST_OAUTH_AUDIENCE : string ; CAMUNDA_TENANT_ID : undefined | string ; CAMUNDA_TOKEN_CACHE_DIR : undefined | string ; CAMUNDA_TOKEN_DISK_CACHE_DISABLE : boolean ; CAMUNDA_TOKEN_SCOPE : undefined | string ; CAMUNDA_ZEEBE_OAUTH_AUDIENCE : string ; ZEEBE_ADDRESS : string ; ZEEBE_CLIENT_ID : undefined | string ; ZEEBE_CLIENT_SECRET : undefined | string ; zeebeGrpcSettings : { GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA : number ; GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS : number ; GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS : number ; GRPC_INITIAL_RECONNECT_BACKOFF_MS : string | number ; GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS : number ; GRPC_KEEPALIVE_TIMEOUT_MS : number ; GRPC_KEEPALIVE_TIME_MS : number ; GRPC_MAX_RECONNECT_BACKOFF_MS : string | number ; GRPC_MIN_RECONNECT_BACKOFF_MS : string | number ; ZEEBE_CLIENT_LOG_LEVEL : string ; ZEEBE_CLIENT_LOG_TYPE : string ; ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS : number ; ZEEBE_GRPC_CLIENT_EAGER_CONNECT : boolean ; ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS : undefined | number ; ZEEBE_GRPC_CLIENT_MAX_RETRIES : number ; ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS : number ; ZEEBE_GRPC_CLIENT_RETRY : boolean ; ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS : number ; ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS : number ; } ; } > Properties Private audience audience : { CONSOLE : string ; MODELER : string ; OPERATE : string ; OPTIMIZE : string ; TASKLIST : string ; ZEEBE : string ; }
Type declaration CONSOLE : string MODELER : string OPERATE : string OPTIMIZE : string TASKLIST : string ZEEBE : string Private auth auth : string
Private cache cache : string
Private camunda camunda : undefined | string
Private client client : undefined | string
Private client client : undefined | string
Private console console : undefined | string
Private console console : undefined | string
Private Optional custom custom ?: Buffer
Private failed failed : boolean = false
Private failure failure : number = 0
Private Optional inflight inflight ?: Promise < string >
Private is is : boolean
Private scope scope : undefined | string
token token : { [
key :
string ]
: Token ; } = {} Private token token : number
Private use use : boolean
user user : string
Static Private Readonly default default : string = ...
Methods Private add add ( audienceType ) : string Returns string Private evict evict ( __namedParameters ) : void Returns void Private evict evict ( audience ) : void Returns void flush flush ( ) : void Returns void flush flush ( ) : void Returns void Private get get ( audience ) : string Returns string Private get get ( audience ) : string Returns string Private get get ( clientId , audience ) : string Returns string get get ( audienceType ) : Promise < string > Returns Promise < string > Private is is ( token ) : boolean Returns boolean Private make make ( __namedParameters ) : Promise < string > Parameters __namedParameters : { audienceType : TokenGrantAudienceType ; clientIdToUse : string ; clientSecretToUse : string ; } client : string client : string Returns Promise < string > Private retrieve retrieve ( clientId , audience ) : null | Token Returns null | Token Private send send ( __namedParameters ) : void Returns void Private send send ( __namedParameters ) : void Returns void
\ No newline at end of file
+
Constructors constructor new OAuth ( options ? ) : OAuthProvider Parameters Optional options : { config ?: DeepPartial < { CAMUNDA_CONSOLE_BASE_URL : undefined | string ; CAMUNDA_CONSOLE_CLIENT_ID : undefined | string ; CAMUNDA_CONSOLE_CLIENT_SECRET : undefined | string ; CAMUNDA_CONSOLE_OAUTH_AUDIENCE : string ; CAMUNDA_CUSTOM_CERT_CHAIN_PATH : undefined | string ; CAMUNDA_CUSTOM_PRIVATE_KEY_PATH : undefined | string ; CAMUNDA_CUSTOM_ROOT_CERT_PATH : undefined | string ; CAMUNDA_CUSTOM_USER_AGENT_STRING : undefined | string ; CAMUNDA_MODELER_BASE_URL : string ; CAMUNDA_MODELER_OAUTH_AUDIENCE : undefined | string ; CAMUNDA_OAUTH_DISABLED : boolean ; CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS : number ; CAMUNDA_OAUTH_URL : undefined | string ; CAMUNDA_OPERATE_BASE_URL : undefined | string ; CAMUNDA_OPERATE_OAUTH_AUDIENCE : string ; CAMUNDA_OPTIMIZE_BASE_URL : undefined | string ; CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE : string ; CAMUNDA_SECURE_CONNECTION : boolean ; CAMUNDA_TASKLIST_BASE_URL : undefined | string ; CAMUNDA_TASKLIST_OAUTH_AUDIENCE : string ; CAMUNDA_TENANT_ID : undefined | string ; CAMUNDA_TOKEN_CACHE_DIR : undefined | string ; CAMUNDA_TOKEN_DISK_CACHE_DISABLE : boolean ; CAMUNDA_TOKEN_SCOPE : undefined | string ; CAMUNDA_ZEEBE_OAUTH_AUDIENCE : string ; ZEEBE_ADDRESS : string ; ZEEBE_CLIENT_ID : undefined | string ; ZEEBE_CLIENT_SECRET : undefined | string ; zeebeGrpcSettings : { GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA : number ; GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS : number ; GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS : number ; GRPC_INITIAL_RECONNECT_BACKOFF_MS : string | number ; GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS : number ; GRPC_KEEPALIVE_TIMEOUT_MS : number ; GRPC_KEEPALIVE_TIME_MS : number ; GRPC_MAX_RECONNECT_BACKOFF_MS : string | number ; GRPC_MIN_RECONNECT_BACKOFF_MS : string | number ; ZEEBE_CLIENT_LOG_LEVEL : string ; ZEEBE_CLIENT_LOG_TYPE : string ; ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS : number ; ZEEBE_GRPC_CLIENT_EAGER_CONNECT : boolean ; ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS : undefined | number ; ZEEBE_GRPC_CLIENT_MAX_RETRIES : number ; ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS : number ; ZEEBE_GRPC_CLIENT_RETRY : boolean ; ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS : number ; ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS : number ; } ; } > ; } Optional config ?: DeepPartial < { CAMUNDA_CONSOLE_BASE_URL : undefined | string ; CAMUNDA_CONSOLE_CLIENT_ID : undefined | string ; CAMUNDA_CONSOLE_CLIENT_SECRET : undefined | string ; CAMUNDA_CONSOLE_OAUTH_AUDIENCE : string ; CAMUNDA_CUSTOM_CERT_CHAIN_PATH : undefined | string ; CAMUNDA_CUSTOM_PRIVATE_KEY_PATH : undefined | string ; CAMUNDA_CUSTOM_ROOT_CERT_PATH : undefined | string ; CAMUNDA_CUSTOM_USER_AGENT_STRING : undefined | string ; CAMUNDA_MODELER_BASE_URL : string ; CAMUNDA_MODELER_OAUTH_AUDIENCE : undefined | string ; CAMUNDA_OAUTH_DISABLED : boolean ; CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS : number ; CAMUNDA_OAUTH_URL : undefined | string ; CAMUNDA_OPERATE_BASE_URL : undefined | string ; CAMUNDA_OPERATE_OAUTH_AUDIENCE : string ; CAMUNDA_OPTIMIZE_BASE_URL : undefined | string ; CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE : string ; CAMUNDA_SECURE_CONNECTION : boolean ; CAMUNDA_TASKLIST_BASE_URL : undefined | string ; CAMUNDA_TASKLIST_OAUTH_AUDIENCE : string ; CAMUNDA_TENANT_ID : undefined | string ; CAMUNDA_TOKEN_CACHE_DIR : undefined | string ; CAMUNDA_TOKEN_DISK_CACHE_DISABLE : boolean ; CAMUNDA_TOKEN_SCOPE : undefined | string ; CAMUNDA_ZEEBE_OAUTH_AUDIENCE : string ; ZEEBE_ADDRESS : string ; ZEEBE_CLIENT_ID : undefined | string ; ZEEBE_CLIENT_SECRET : undefined | string ; zeebeGrpcSettings : { GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA : number ; GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS : number ; GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS : number ; GRPC_INITIAL_RECONNECT_BACKOFF_MS : string | number ; GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS : number ; GRPC_KEEPALIVE_TIMEOUT_MS : number ; GRPC_KEEPALIVE_TIME_MS : number ; GRPC_MAX_RECONNECT_BACKOFF_MS : string | number ; GRPC_MIN_RECONNECT_BACKOFF_MS : string | number ; ZEEBE_CLIENT_LOG_LEVEL : string ; ZEEBE_CLIENT_LOG_TYPE : string ; ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS : number ; ZEEBE_GRPC_CLIENT_EAGER_CONNECT : boolean ; ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS : undefined | number ; ZEEBE_GRPC_CLIENT_MAX_RETRIES : number ; ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS : number ; ZEEBE_GRPC_CLIENT_RETRY : boolean ; ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS : number ; ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS : number ; } ; } > Properties Private audience audience : { CONSOLE : string ; MODELER : string ; OPERATE : string ; OPTIMIZE : string ; TASKLIST : string ; ZEEBE : string ; }
Type declaration CONSOLE : string MODELER : string OPERATE : string OPTIMIZE : string TASKLIST : string ZEEBE : string Private auth auth : string
Private cache cache : string
Private camunda camunda : undefined | string
Private client client : undefined | string
Private client client : undefined | string
Private console console : undefined | string
Private console console : undefined | string
Private Optional custom custom ?: Buffer
Private failed failed : boolean = false
Private failure failure : number = 0
Private Optional inflight inflight ?: Promise < string >
Private is is : boolean
Private scope scope : undefined | string
token token : { [
key :
string ]
: Token ; } = {} Private token token : number
Private use use : boolean
user user : string
Static Private Readonly default default : string = ...
Methods Private add add ( audienceType ) : string Returns string Private evict evict ( __namedParameters ) : void Returns void Private evict evict ( audience ) : void Returns void flush flush ( ) : void Returns void flush flush ( ) : void Returns void Private get get ( audience ) : string Returns string Private get get ( audience ) : string Returns string Private get get ( clientId , audience ) : string Returns string get get ( audienceType ) : Promise < string > Returns Promise < string > Private is is ( token ) : boolean Returns boolean Private make make ( __namedParameters ) : Promise < string > Parameters __namedParameters : { audienceType : TokenGrantAudienceType ; clientIdToUse : string ; clientSecretToUse : string ; } client : string client : string Returns Promise < string > Private retrieve retrieve ( clientId , audience ) : null | Token Returns null | Token Private send send ( __namedParameters ) : void Returns void Private send send ( __namedParameters ) : void Returns void
\ No newline at end of file
diff --git a/classes/index.Camunda8.html b/classes/index.Camunda8.html
index 9819c925..1e303feb 100644
--- a/classes/index.Camunda8.html
+++ b/classes/index.Camunda8.html
@@ -2,7 +2,7 @@
This class is a facade for all the clients in the Camunda Platform 8 SDK.
Description
Create a new API client for a cluster. See the API Documentation for more details.
-