Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "index"

Index

References

APIs Functions

Other Functions

References

Callback

Re-exports Callback

ErrorCallback

Re-exports ErrorCallback

ExpressHandler

Re-exports ExpressHandler

ExternalRefreshRequest

Re-exports ExternalRefreshRequest

ExternalRefreshResponse

Re-exports ExternalRefreshResponse

ExternalUserPassRequest

Re-exports ExternalUserPassRequest

ExternalUserPassResponse

Re-exports ExternalUserPassResponse

KongApi

Re-exports KongApi

KongApiConfig

Re-exports KongApiConfig

KongCollection

Re-exports KongCollection

KongConsumer

Re-exports KongConsumer

KongGlobals

Re-exports KongGlobals

KongHttpDirective

Re-exports KongHttpDirective

KongPlugin

Re-exports KongPlugin

KongPluginBotDetection

Re-exports KongPluginBotDetection

KongPluginCorrelationId

Re-exports KongPluginCorrelationId

KongPluginCorrelationIdGeneratorType

Re-exports KongPluginCorrelationIdGeneratorType

KongPluginCors

Re-exports KongPluginCors

KongPluginHmacAuth

Re-exports KongPluginHmacAuth

KongPluginOAuth2

Re-exports KongPluginOAuth2

KongPluginRateLimiting

Re-exports KongPluginRateLimiting

KongPluginRequestTransformer

Re-exports KongPluginRequestTransformer

KongPluginResponseTransformer

Re-exports KongPluginResponseTransformer

KongPluginWhiteBlackList

Re-exports KongPluginWhiteBlackList

KongProxyListener

Re-exports KongProxyListener

KongRoute

Re-exports KongRoute

KongService

Re-exports KongService

KongStatus

Re-exports KongStatus

OidcProfile

Re-exports OidcProfile

PassthroughScopeRequest

Re-exports PassthroughScopeRequest

PassthroughScopeResponse

Re-exports PassthroughScopeResponse

ProtocolType

Re-exports ProtocolType

ScopeLookupResponse

Re-exports ScopeLookupResponse

WickedApi

Re-exports WickedApi

WickedApiCollection

Re-exports WickedApiCollection

WickedApiPlan

Re-exports WickedApiPlan

WickedApiPlanCollection

Re-exports WickedApiPlanCollection

WickedApiScopes

Re-exports WickedApiScopes

WickedApiSettings

Re-exports WickedApiSettings

WickedApplication

Re-exports WickedApplication

WickedApplicationCreateInfo

Re-exports WickedApplicationCreateInfo

WickedApplicationRole

Re-exports WickedApplicationRole

WickedApplicationRoleType

Re-exports WickedApplicationRoleType

WickedApproval

Re-exports WickedApproval

WickedAuthServer

Re-exports WickedAuthServer

WickedAwaitOptions

Re-exports WickedAwaitOptions

WickedChatbotTemplates

Re-exports WickedChatbotTemplates

WickedClientType

Re-exports WickedClientType

WickedCollection

Re-exports WickedCollection

WickedComponentHealth

Re-exports WickedComponentHealth

WickedEmailTemplateType

Re-exports WickedEmailTemplateType

WickedError

Re-exports WickedError

WickedEvent

Re-exports WickedEvent

WickedGetCollectionOptions

Re-exports WickedGetCollectionOptions

WickedGetOptions

Re-exports WickedGetOptions

WickedGetRegistrationOptions

Re-exports WickedGetRegistrationOptions

WickedGlobals

Re-exports WickedGlobals

WickedGrant

Re-exports WickedGrant

WickedGroupCollection

Re-exports WickedGroupCollection

WickedInitOptions

Re-exports WickedInitOptions

WickedNamespace

Re-exports WickedNamespace

WickedPasswordStrategy

Re-exports WickedPasswordStrategy

WickedPool

Re-exports WickedPool

WickedPoolMap

Re-exports WickedPoolMap

WickedRegistration

Re-exports WickedRegistration

WickedRegistrationMap

Re-exports WickedRegistrationMap

WickedScopeGrant

Re-exports WickedScopeGrant

WickedSessionStoreType

Re-exports WickedSessionStoreType

WickedSubscription

Re-exports WickedSubscription

WickedSubscriptionCreateInfo

Re-exports WickedSubscriptionCreateInfo

WickedSubscriptionInfo

Re-exports WickedSubscriptionInfo

WickedSubscriptionPatchInfo

Re-exports WickedSubscriptionPatchInfo

WickedSubscriptionScopeModeType

Re-exports WickedSubscriptionScopeModeType

WickedUserCreateInfo

Re-exports WickedUserCreateInfo

WickedUserInfo

Re-exports WickedUserInfo

WickedUserShortInfo

Re-exports WickedUserShortInfo

WickedVerification

Re-exports WickedVerification

WickedWebhookListener

Re-exports WickedWebhookListener

kongApiToServiceAndRoutes

Re-exports kongApiToServiceAndRoutes

kongApiToServiceRoute

Re-exports kongApiToServiceRoute

kongServiceAndRoutesToApi

Re-exports kongServiceAndRoutesToApi

kongServiceRouteToApi

Re-exports kongServiceRouteToApi

APIs Functions

getApis

Other Functions

addApplicationOwner

addApplicationOwnerAs

apiDelete

  • apiDelete(urlPath: string, userIdOrCallback: any, callback: any): any
  • General purpose DELETE operation on the wicked API; you do not use this directly usually, but use one of the dedicated SDK functions.

    Parameters

    • urlPath: string

      relative URL path

    • userIdOrCallback: any

      user ID to perform the GET operation as, or callback

    • callback: any

      Callback containing an err (or null if success) and the GET returned content.

    Returns any

apiGet

  • apiGet(urlPath: string, userIdOrCallback: any, callback: any): any
  • General purpose GET operation on the wicked API; you do not use this directly usually, but use one of the dedicated SDK functions.

    Parameters

    • urlPath: string

      relative URL path

    • userIdOrCallback: any

      user ID to perform the GET operation as, or callback

    • callback: any

      Callback containing an err (or null if success) and the GET returned content.

    Returns any

apiPatch

  • apiPatch(urlPath: string, patchBody: object, userIdOrCallback: any, callback: any): any
  • General purpose PATCH operation on the wicked API; you do not use this directly usually, but use one of the dedicated SDK functions.

    Parameters

    • urlPath: string

      relative URL path

    • patchBody: object
    • userIdOrCallback: any

      user ID to perform the GET operation as, or callback

    • callback: any

      Callback containing an err (or null if success) and the GET returned content.

    Returns any

apiPost

  • apiPost(urlPath: string, postBody: object, userIdOrCallback: any, callback: any): any
  • General purpose POST operation on the wicked API; you do not use this directly usually, but use one of the dedicated SDK functions.

    Parameters

    • urlPath: string

      relative URL path

    • postBody: object

      Body to post

    • userIdOrCallback: any

      user ID to perform the GET operation as, or callback

    • callback: any

      Callback containing an err (or null if success) and the GET returned content.

    Returns any

apiPut

  • apiPut(urlPath: string, putBody: object, userIdOrCallback: any, callback: any): any
  • General purpose PUT operation on the wicked API; you do not use this directly usually, but use one of the dedicated SDK functions.

    Parameters

    • urlPath: string

      relative URL path

    • putBody: object

      Body to post

    • userIdOrCallback: any

      user ID to perform the GET operation as, or callback

    • callback: any

      Callback containing an err (or null if success) and the GET returned content.

    Returns any

awaitKongAdapter

awaitUrl

correlationIdHandler

  • Express middleware implementation of a correlation ID handler; it inserts a header Correlation-Id if it's not already present and passes it on to the wicked API. In case a header is already present, it re-uses the content. The usual format of the correlation ID is a UUID.

    Usage: app.use(wicked.correlationIdHandler());

    Returns ExpressHandler

createApplication

createApplicationAs

createSubscription

createSubscriptionAs

createUser

createUserAs

createVerification

createVerificationAs

deleteAllUserGrants

  • deleteAllUserGrants(userId: string): Promise<any>
  • deleteAllUserGrants(userId: string, callback: ErrorCallback): any

deleteAllUserGrantsAs

  • deleteAllUserGrantsAs(userId: string, asUserId: string): Promise<any>
  • deleteAllUserGrantsAs(userId: string, asUserId: string, callback: ErrorCallback): any

deleteApplication

  • deleteApplication(appId: string): Promise<any>
  • deleteApplication(appId: string, callback: ErrorCallback): any

deleteApplicationAs

  • deleteApplicationAs(appId: string, asUserId: any): Promise<any>
  • deleteApplicationAs(appId: string, asUserId: string, callback: ErrorCallback): any

deleteApplicationOwner

deleteApplicationOwnerAs

  • deleteApplicationOwnerAs(appId: string, email: string, asUserId: string): Promise<WickedApplication>
  • deleteApplicationOwnerAs(appId: string, email: string, asUserId: string, callback: Callback<WickedApplication>): any

deletePoolNamespace

  • deletePoolNamespace(poolId: string, namespaceId: string): Promise<any>
  • deletePoolNamespace(poolId: string, namespaceId: string, callback: ErrorCallback): any

deletePoolNamespaceAs

  • deletePoolNamespaceAs(poolId: string, namespaceId: string, asUserId: string): Promise<any>
  • deletePoolNamespaceAs(poolId: string, namespaceId: string, asUserId: string, callback: ErrorCallback): any

deleteSubscription

  • deleteSubscription(appId: string, apiId: string): Promise<any>
  • deleteSubscription(appId: string, apiId: string, callback: ErrorCallback): any

deleteSubscriptionAs

  • deleteSubscriptionAs(appId: string, apiId: string, asUserId: string): Promise<any>
  • deleteSubscriptionAs(appId: string, apiId: string, asUserId: string, callback: ErrorCallback): any

deleteUser

  • deleteUser(userId: string): Promise<any>
  • deleteUser(userId: string, callback: ErrorCallback): any

deleteUserAs

  • deleteUserAs(userId: string, asUserId: string): Promise<any>
  • deleteUserAs(userId: string, asUserId: string, callback: ErrorCallback): any

deleteUserGrant

  • deleteUserGrant(userId: string, applicationId: string, apiId: string): Promise<any>
  • deleteUserGrant(userId: string, applicationId: string, apiId: string, callback: ErrorCallback): any

deleteUserGrantAs

  • deleteUserGrantAs(userId: string, applicationId: string, apiId: string, asUserId: string): Promise<any>
  • deleteUserGrantAs(userId: string, applicationId: string, apiId: string, asUserId: string, callback: ErrorCallback): any

deleteUserPassword

  • deleteUserPassword(userId: string): Promise<any>
  • deleteUserPassword(userId: string, callback: ErrorCallback): any

deleteUserPasswordAs

  • deleteUserPasswordAs(userId: string, asUserId: string): Promise<any>
  • deleteUserPasswordAs(userId: string, asUserId: string, callback: ErrorCallback): any

deleteUserRegistration

  • deleteUserRegistration(poolId: string, userId: string, namespaceId: string): Promise<any>
  • deleteUserRegistration(poolId: string, userId: string, namespaceId: string, callback: ErrorCallback): any
  • Delete a specific user registration for a given registration pool (and optionally namespace).

    Parameters

    • poolId: string

      ID of registration pool to delete a user registration from

    • userId: string

      ID of user to delete a registration for

    • namespaceId: string

      Namespace to delete registration for; for registration pools not requiring a namespace, this must be null, otherwise it must be specified

    Returns Promise<any>

  • Parameters

    • poolId: string
    • userId: string
    • namespaceId: string
    • callback: ErrorCallback

    Returns any

deleteUserRegistrationAs

  • deleteUserRegistrationAs(poolId: string, userId: string, namespaceId: string, asUserId: string): Promise<any>
  • deleteUserRegistrationAs(poolId: string, userId: string, namespaceId: string, asUserId: string, callback: ErrorCallback): any

deleteVerification

  • deleteVerification(verificationId: string): Promise<any>
  • deleteVerification(verificationId: string, callback: ErrorCallback): any

deleteVerificationAs

  • deleteVerificationAs(verificationId: string, asUserId: string): Promise<any>
  • deleteVerificationAs(verificationId: string, asUserId: string, callback: ErrorCallback): any

deleteWebhookEvent

  • deleteWebhookEvent(listenerId: string, eventId: string): Promise<any>
  • deleteWebhookEvent(listenerId: string, eventId: string, callback: ErrorCallback): any

deleteWebhookEventAs

  • deleteWebhookEventAs(listenerId: string, eventId: string, asUserId: string): Promise<any>
  • deleteWebhookEventAs(listenerId: string, eventId: string, asUserId: string, callback: ErrorCallback): any

deleteWebhookListener

  • deleteWebhookListener(listenerId: string): Promise<any>
  • deleteWebhookListener(listenerId: string, callback: ErrorCallback): any

deleteWebhookListenerAs

  • deleteWebhookListenerAs(listenerId: string, asUserId: string): Promise<any>
  • deleteWebhookListenerAs(listenerId: string, asUserId: string, callback: ErrorCallback): any

flushWebhookEvents

  • flushWebhookEvents(listenerId: string): Promise<any>
  • flushWebhookEvents(listenerId: string, callback: ErrorCallback): any

flushWebhookEventsAs

  • flushWebhookEventsAs(listenerId: string, asUserId: string): Promise<any>
  • flushWebhookEventsAs(listenerId: string, asUserId: string, callback: ErrorCallback): any

getAllUserRegistrations

getAllUserRegistrationsAs

getApi

getApiAs

  • getApiAs(apiId: string, asUserId: string): Promise<WickedApi>
  • getApiAs(apiId: string, asUserId: string, callback: Callback<WickedApi>): any

getApiConfig

  • getApiConfig(apiId: string): Promise<any>
  • getApiConfig(apiId: string, callback: Callback<any>): any

getApiConfigAs

  • getApiConfigAs(apiId: string, asUserId: string): Promise<any>
  • getApiConfigAs(apiId: string, asUserId: string, callback: Callback<any>): any

getApiDescription

  • getApiDescription(apiId: string): Promise<string>
  • getApiDescription(apiId: string, callback: Callback<string>): any

getApiDescriptionAs

  • getApiDescriptionAs(apiId: string, asUserId: string): Promise<string>
  • getApiDescriptionAs(apiId: string, asUserId: string, callback: Callback<string>): any

getApiKeyHeader

  • getApiKeyHeader(): string

getApiPlans

getApiPlansAs

getApiSubscriptions

getApiSubscriptionsAs

getApiSwagger

  • getApiSwagger(apiId: string): Promise<object>
  • getApiSwagger(apiId: string, callback: Callback<object>): any

getApiSwaggerAs

  • getApiSwaggerAs(apiId: string, asUserId: string): Promise<object>
  • getApiSwaggerAs(apiId: string, asUserId: string, callback: Callback<object>): any

getApisAs

getApisDescription

  • getApisDescription(): Promise<string>
  • getApisDescription(callback: Callback<string>): any

getApisDescriptionAs

  • getApisDescriptionAs(asUserId: string): Promise<string>
  • getApisDescriptionAs(asUserId: string, callback: Callback<string>): any

getApplication

getApplicationAs

getApplicationRoles

getApplications

getApplicationsAs

getApproval

getApprovalAs

getApprovals

getApprovalsAs

getAuthServer

getAuthServerAs

getAuthServerNames

  • getAuthServerNames(): Promise<string[]>
  • getAuthServerNames(callback: Callback<string[]>): any

getAuthServerNamesAs

  • getAuthServerNamesAs(asUserId: string): Promise<string[]>
  • getAuthServerNamesAs(asUserId: string, callback: Callback<string[]>): any

getChatbotTemplates

getChatbotTemplatesAs

getConfigHash

  • getConfigHash(): string
  • Returns the current hash of the static configuration. This is used to check whether the static configuration has changed, and if so, decide to restart/stop components like the mailer or the kong adapter.

    Returns string

getEmailTemplate

getEmailTemplateAs

getExternalApiHost

  • getExternalApiHost(): string

getExternalApiUrl

  • getExternalApiUrl(): string

getExternalPortalHost

  • getExternalPortalHost(): string

getExternalPortalUrl

  • getExternalPortalUrl(): string

getGlobals

getGroups

getInternalApiUrl

  • getInternalApiUrl(): string

getInternalChatbotUrl

  • getInternalChatbotUrl(): string

getInternalKongAdapterUrl

  • getInternalKongAdapterUrl(): string

getInternalKongAdminUrl

  • getInternalKongAdminUrl(): string

getInternalKongProxyUrl

  • getInternalKongProxyUrl(): string

getInternalMailerUrl

  • getInternalMailerUrl(): string

getInternalPortalUrl

  • getInternalPortalUrl(): string

getInternalUrl

  • getInternalUrl(globalSettingsProperty: string): string

getKongAdapterIgnoreList

  • getKongAdapterIgnoreList(): string[]

getPasswordStrategy

  • getPasswordStrategy(): string

getPlans

getPoolNamespace

getPoolNamespaceAs

  • getPoolNamespaceAs(poolId: string, namespaceId: string, asUserId: string): Promise<WickedNamespace>
  • getPoolNamespaceAs(poolId: string, namespaceId: string, asUserId: string, callback: Callback<WickedNamespace>): any

getPoolNamespaces

getPoolNamespacesAs

getPoolRegistrations

getPoolRegistrationsAs

getPortalApiScope

  • getPortalApiScope(): string

getRegistrationPool

getRegistrationPoolAs

  • getRegistrationPoolAs(poolId: string, asUserId: string): Promise<WickedPool>
  • getRegistrationPoolAs(poolId: string, asUserId: string, callback: Callback<WickedPool>): any

getRegistrationPools

getRegistrationPoolsAs

getSchema

  • getSchema(): string

getSubscription

getSubscriptionAs

getSubscriptionByClientId

getSubscriptionByClientIdAs

getSubscriptions

getSubscriptionsAs

getSystemHealth

getSystemHealthAs

getUser

getUserAs

getUserByCustomId

getUserByEmail

getUserGrant

  • getUserGrant(userId: string, applicationId: string, apiId: string): Promise<WickedGrant>
  • getUserGrant(userId: string, applicationId: string, apiId: string, callback: Callback<WickedGrant>): any

getUserGrantAs

  • getUserGrantAs(userId: string, applicationId: string, apiId: string, asUserId: string): Promise<WickedGrant>
  • getUserGrantAs(userId: string, applicationId: string, apiId: string, asUserId: string, callback: Callback<WickedGrant>): any

getUserGrants

getUserGrantsAs

getUserRegistrations

getUserRegistrationsAs

getUsers

getUsersAs

getVerification

getVerificationAs

getVerifications

getVerificationsAs

getWebhookEvents

getWebhookEventsAs

  • getWebhookEventsAs(listenerId: string, asUserId: string): Promise<WickedEvent[]>
  • getWebhookEventsAs(listenerId: string, asUserId: string, callback: Callback<WickedEvent[]>): any

getWebhookListeners

getWebhookListenersAs

initMachineUser

  • initMachineUser(serviceId: string): Promise<any>
  • initMachineUser(serviceId: string, callback: ErrorCallback): any

initialize

isApiReachable

  • isApiReachable(): boolean

isDevelopmentMode

  • isDevelopmentMode(): boolean

patchApplication

patchApplicationAs

patchSubscription

patchSubscriptionAs

patchUser

patchUserAs

upsertPoolNamespace

  • upsertPoolNamespace(poolId: string, namespaceId: string, namespaceInfo: WickedNamespace): Promise<any>
  • upsertPoolNamespace(poolId: string, namespaceId: string, namespaceInfo: WickedNamespace, callback: ErrorCallback): any

upsertPoolNamespaceAs

  • upsertPoolNamespaceAs(poolId: string, namespaceId: string, namespaceInfo: WickedNamespace, asUserId: string): Promise<any>
  • upsertPoolNamespaceAs(poolId: string, namespaceId: string, namespaceInfo: WickedNamespace, asUserId: string, callback: ErrorCallback): any

upsertUserGrant

  • upsertUserGrant(userId: string, applicationId: string, apiId: string, grantInfo: WickedGrant): Promise<any>
  • upsertUserGrant(userId: string, applicationId: string, apiId: string, grantInfo: WickedGrant, callback: ErrorCallback): any
  • Upsert a grant information for a user, so that a given application can access the given API with a specific set of scopes on the user's behalf. This method is foremost used automatically by the Authorization Server after it has asked the user whether a certain application is allowed to access the user's data on the user's behalf.

    Parameters

    • userId: string

      ID of user to upsert a grant for

    • applicationId: string

      ID of application to upsert a grant for

    • apiId: string

      ID of API to upsert a grant for

    • grantInfo: WickedGrant

      Grant information to store

    Returns Promise<any>

  • Parameters

    Returns any

upsertUserGrantAs

  • upsertUserGrantAs(userId: string, applicationId: string, apiId: string, grantInfo: WickedGrant, asUserId: string): Promise<any>
  • upsertUserGrantAs(userId: string, applicationId: string, apiId: string, grantInfo: WickedGrant, asUserId: string, callback: ErrorCallback): any

upsertUserRegistration

upsertUserRegistrationAs

  • upsertUserRegistrationAs(poolId: string, userId: string, userRegistration: WickedRegistration, asUserId: string): Promise<any>
  • upsertUserRegistrationAs(poolId: string, userId: string, userRegistration: WickedRegistration, asUserId: string, callback: ErrorCallback): any

upsertWebhookListener

upsertWebhookListenerAs

Generated using TypeDoc